docs: add branch protection policy and emphasize mandatory documentat…#43
Conversation
…ion updates in AGENTS.md
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the AGENTS.md file to enforce a strict source control policy prohibiting direct commits to the main branch and strengthens the requirement for documentation updates after every change. Feedback suggests refining the documentation rule to include 'as necessary' to account for internal changes that do not impact the project's public state or interface.
| - **Verification**: All changes must be verified by ensuring that all tests pass (`ctest`). | ||
| - **Project Documentation**: After any code changes, `README.md` and `AGENTS.md` must be reviewed and updated if necessary to reflect the current state of the project. | ||
| - **Source Control**: NEVER commit directly to the `main` branch. Always use feature branches and pull requests for any changes. | ||
| - **Project Documentation**: After EVERY change, `README.md` and `AGENTS.md` MUST be reviewed and updated to reflect the current state of the project. |
There was a problem hiding this comment.
The requirement to update documentation after EVERY change is logically problematic for changes that do not affect the project's state or interface (e.g., internal refactoring or fixing typos in comments). While the emphasis on documentation is important for an agent-based project, requiring an update when none is applicable can be confusing. It is better to specify that the files must be reviewed and updated as necessary to reflect the current state.
| - **Project Documentation**: After EVERY change, `README.md` and `AGENTS.md` MUST be reviewed and updated to reflect the current state of the project. | |
| - **Project Documentation**: After every change, `README.md` and `AGENTS.md` MUST be reviewed and updated as necessary to reflect the current state of the project. |
1 participant
…ion updates in AGENTS.md