Skip to content

docs: add branch protection policy and emphasize mandatory documentat… #43

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ipapadop merged 1 commit into from
Apr 25, 2026
Merged

docs: add branch protection policy and emphasize mandatory documentat… #43

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,8 @@ Or simply copy the `include/deferred` directory to your project's include path.
- **Testing**: New features must include unit tests in `test/unit/` and integration tests in `test/integration/`. Tests use the Catch2 v3 framework.
- **Catch2 v3**: Uses `#include <catch2/catch_test_macros.hpp>` and requires a custom `main` in `main.cpp` using `Catch::Session().run()`.
- **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.
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot Apr 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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.

Suggested change
- **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.

- **License**: MIT License. All source files should include the standard MIT license header.
- **Header Guards**: Use `#ifndef DEFERRED_FILENAME_HPP` format.
- **CI**: GitHub Actions workflow (`.github/workflows/c-cpp.yml`) builds the project on Ubuntu, Windows (MSVC), and macOS.
Loading