Repository navigation
docs(repo): clarify contribution workflow and testing requirements - #179
Conversation
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
- Reorganize CONTRIBUTING.md to clearly state requirements for DCO, license headers, and conventional commits. - Introduce `.gitmessage` template to help contributors format commit messages. - Update PR template checklist to include Python (`pytest`) alongside C/CMake testing. - Add warning against "evil merges" to maintain a clean git history. Closes embeddedos-org#178 Signed-off-by: Benjamín Guzmán <code@bguzman.dev>
ec9ac8f to
88f4774
Compare
…its rule CI sets --cov-fail-under=0, so 'Uncovered code will block the PR' was not true. Fold the orphaned DCO heading into requirement 1 and list ruff, which CI runs before pytest. Signed-off-by: Srikanth Patchava <srpatcha@users.noreply.github.com>
|
Thanks — pushed one small commit on top (signed off) rather than asking for a round-trip:
|
|
Hi @srpatcha, thanks for taking a detailed look |
Aswin-V
left a comment
Aswin-V
left a comment
There was a problem hiding this comment.
Reviewed. Docs-only reorganization — CI is green across the board (incl. Linked Issue policy). The CONTRIBUTING rewrite is a genuine improvement: "run what CI runs" finally names the real gates (ruff check ., python -m pytest tests/) instead of only the C/CMake path, and the evil-merge tip is worth keeping.
One nit on .gitmessage: the line Fixes/resolves/closes #<issue number> isn't prefixed with #, so if a contributor forgets to replace it, it ships literally into the commit message as placeholder text. Consider commenting it out like the other guidance lines. Not a blocker.
Note for the record: my role here is reviewer only — I don't merge contributors' PRs. Ready to merge from your side.
Summary
This PR improves and clarifies the repository's contribution guidelines, test requirements, and commit conventions to ensure a smoother onboarding process and maintain a clean git history.
Type of Change
Changes
CONTRIBUTING.mdto clearly state requirements for DCO, license headers, and conventional commits..gitmessagetemplate to help contributors format commit messages.Testing
ctest --test-dir build --output-on-failure)Pre-Submission Checklist
-Wall -Wextra -Werrorfor C)<type>(<scope>): <description>conventionmasterRelated Issue
Closes #178
Screenshots / Logs
N/A (Documentation changes only).
Additional Notes
Contributors can now optionally run
git config commit.template .gitmessageto enable the new conventional commits template locally on their machines.