Skip to content

enhancement(docs and branches): correct the README, the branch difference and the Cursor rules #11

Description

@nabil1440

Blocker: no. This can wait. If you use Cursor or a different AI tool for the refactor, do the Cursor rules item first.

Defect

Cost

  • New users get old or incorrect instructions.
  • Contributors who do not know the branch policy can push to the wrong branch.
  • The development branch does not include the commit that is only on main.
  • AI tools that read the Cursor rules copy the defective error pattern. They also trust a validation that does not exist.

Benefit of the fix

  • The documentation agrees with the code.
  • The documented branch policy tells contributors where to push.
  • AI tools get correct project rules.

Fix

  1. Document the branch policy in the README: main is the release branch, and develop is the development branch.
  2. Merge main into develop.
  3. On develop, correct or remove .cursor/rules/project-rules.mdc. The next release merge takes the change to main.
  4. Remove the fixed version from the manual installation example.
  5. Document how to send flags to the container.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions