docs: add contributing guidelines #37
Conversation
Add concise and welcoming contribution guidelines covering: - Getting started steps - Development workflow - Branch naming conventions - Submission process 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
There was a problem hiding this comment.
Pull Request Overview
This PR adds a new CONTRIBUTING.md to guide community contributions by covering setup, development workflow, and submission processes.
- Introduce a CONTRIBUTING.md with setup and branch workflow instructions
- Outline development conventions and commit message guidance
- Describe pull request submission and rebasing policy
Comments suppressed due to low confidence (1)
CONTRIBUTING.md:24
- The 'General' section currently only mentions rebasing but the PR summary promises branch naming conventions; consider adding explicit branch naming patterns (e.g., feature/, bugfix/) and renaming this section to 'Workflow Conventions' or similar.
## General
| - Follow the existing code style and conventions | ||
| - Write clear, descriptive commit messages | ||
| - Test your changes before submitting | ||
| - Keep functions small and focused |
There was a problem hiding this comment.
[nitpick] List formatting is inconsistent between sections (ordered lists under 'Getting Started' and bullet lists under 'Development'); consider using a consistent list style within each section for readability.
| - Follow the existing code style and conventions | |
| - Write clear, descriptive commit messages | |
| - Test your changes before submitting | |
| - Keep functions small and focused | |
| 1. Follow the existing code style and conventions | |
| 2. Write clear, descriptive commit messages | |
| 3. Test your changes before submitting | |
| 4. Keep functions small and focused |
Copilot uses AI. Check for mistakes.
![graphite-app[bot]](https://avatars.githubusercontent.com/in/158384?s=60&v=4){kind=small}
|
|
||
| ## Questions? | ||
|
|
||
| Feel free to open an issue if you have questions or need help getting started. We're here to help! |
There was a problem hiding this comment.
The file is missing a newline at the end, which is a common formatting convention. Adding a newline character after the exclamation mark would align with standard file formatting practices that many tools and developers expect.
Spotted by Diamond
Is this helpful? React 👍 or 👎 to let us know.
Summary
Changes
🤖 Generated with Claude Code