-
Notifications
You must be signed in to change notification settings - Fork 13
Add a CONTRIBUTING.md file #55
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.
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
base: main
Are you sure you want to change the base?
Conversation
6fc2ee2
to
33d4c10
Compare
33d4c10
to
03b4b8f
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
A new CONTRIBUTING.md file outlining the project’s contributor guidelines, workflow, and support resources.
- Introduces sections on Code of Conduct, issue reporting, pull request process, coding and commit conventions
- Details testing, development setup, Makefile targets, and help channels
- Notes project status and future rule evolution
Comments suppressed due to low confidence (3)
CONTRIBUTING.md:12
- Link to the actual Code of Conduct document (e.g., CODE_OF_CONDUCT.md) so contributors can review it directly.
By participating in this project, you agree to follow our Code of Conduct.
CONTRIBUTING.md:68
- Note that the
make review
target is pending in a future PR—consider adding a TODO or link to the tracking issue so contributors know when it will be available.
- Run `make review` before submitting changes
CONTRIBUTING.md:104
- Provide a link to the specific documentation directory or README so contributors know exactly where to look.
- Read through our documentation
1. Create a new branch for your changes | ||
1. Make your changes following our coding conventions | ||
- If you are not sure about the coding conventions, please ask | ||
- Look at the existing code for examples | ||
1. Write clear commit messages | ||
1. Update tests and documentation | ||
1. Submit a pull request |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nitpick] Consider renumbering the steps (1, 2, 3…) instead of repeating '1.' for clarity, or prefix with bullets if order isn’t critical.
1. Create a new branch for your changes | |
1. Make your changes following our coding conventions | |
- If you are not sure about the coding conventions, please ask | |
- Look at the existing code for examples | |
1. Write clear commit messages | |
1. Update tests and documentation | |
1. Submit a pull request | |
2. Create a new branch for your changes | |
3. Make your changes following our coding conventions | |
- If you are not sure about the coding conventions, please ask | |
- Look at the existing code for examples | |
4. Write clear commit messages | |
5. Update tests and documentation | |
6. Submit a pull request |
Copilot uses AI. Check for mistakes.
- Use `gofmt` to format your code | ||
- Write descriptive comments for non-obvious code | ||
- Add tests for your work | ||
- Keep line length to 80 characters |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nitpick] Go style typically relies on gofmt rather than strict line-length limits—consider removing or updating this rule to align with automated formatting.
- Keep line length to 80 characters |
Copilot uses AI. Check for mistakes.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
(as long as we enforce most of these using automation! as it is hard to remember all the conventions in different repos)
This is a stab at a Contributing rules file.
Please review and make suggestions.
Most of the content was AI generated, but I added a few things myself.
The point about
make review
will depend on another forthcoming PR.That command will try to enforce all the rules locally.
And we can also invoke it from GitHub actions for PRS.