-
Notifications
You must be signed in to change notification settings - Fork 116
docs: Add contributing guidelines #5407
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
Conversation
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
This PR introduces comprehensive contributing guidelines for the snapcraft.io project to help new contributors understand how to participate in the project effectively.
- Adds a new CONTRIBUTING.md file with detailed guidelines covering bug reporting, feature suggestions, code contributions, and community standards
- Provides clear instructions for different types of contributions including bug reports, feature requests, and code submissions
- Establishes expectations around the review process, licensing requirements, and AI tool usage
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
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.
Looks good! I have a small suggestion for the section on AI tools. It's a reasonable expectation that the contributors know what the code in their PR does, but you never know 😂
Co-authored-by: Eduard M <4310497+edisile@users.noreply.github.com>
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.
Looks good!
* docs: Add contributing guidelines * Update CONTRIBUTING.md Co-authored-by: Eduard M <4310497+edisile@users.noreply.github.com> --------- Co-authored-by: Eduard M <4310497+edisile@users.noreply.github.com>
Done
Adds contributing guidelines to the repo
How to QA
Review the text of the CONTRIBUTING.md file.
Testing
Issue / Card
Fixes https://warthogs.atlassian.net/browse/WD-29043