docs: add CONTRIBUTING.md #197
Conversation
WalkthroughA new Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
Hi maintainers |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
CONTRIBUTING.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
CONTRIBUTING.md
[style] ~18-~18: Consider using a different verb for a more formal wording.
Context: ...rovements 3. Improving documentation 4. Fixing existing issues 5. Reviewing pull reque...
(FIX_RESOLVE)
🔇 Additional comments (3)
CONTRIBUTING.md (3)
1-6: Welcoming introduction sets a positive tone.The opening clearly expresses appreciation and sets inclusive expectations for contributors of all experience levels. This is well-crafted for onboarding.
8-10: Code of Conduct reference is appropriate.The link to CODE_OF_CONDUCT.md is clear and the commitment statement reinforces community values. Ensure that CODE_OF_CONDUCT.md exists in the repository root.
13-26: Contribution types are well-organized and practical guidance is helpful.The list of five contribution pathways is clear, and the advice to check for
good first issue,bug, andenhancementlabels is practical. The suggestion to comment before starting work prevents duplicate effort—good practice.
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
CONTRIBUTING.md (1)
49-61: Add commit message conventions guidance.The file covers branch naming conventions and PR guidelines but lacks guidance on commit message format. Specify whether the project follows Conventional Commits, requires a specific message template, or has other conventions (e.g., imperative mood, issue references, sign-offs).
🔎 Proposed addition: Commit Conventions section
Example: ```bash git checkout -b docs/add-contributing-md+## Commit Message Conventions
+Follow these guidelines when writing commit messages:
+- Use the imperative mood: "Add feature" not "Added feature"
+- Keep the first line under 50 characters
+- Reference related issues: "Fixes #123" or "Related to #456"
+- Separate subject from body with a blank line (for detailed commits)
+
+Example:
++docs: add contribution guidelines + +Add a comprehensive CONTRIBUTING.md file to help new contributors +understand the project setup and contribution workflow. + +Fixes #162 +Pull Request Guidelines
</details> </blockquote></details> </blockquote></details> <details> <summary>🧹 Nitpick comments (2)</summary><blockquote> <details> <summary>CONTRIBUTING.md (2)</summary><blockquote> `13-19`: **Minor style refinement for list consistency.** Line 18 uses "Improving documentation" whereas other list items use verb + noun format ("Reporting bugs", "Suggesting features"). Consider "Improving" → "Documenting" or "Contributing documentation" for consistent phrasing. <details> <summary>🔎 Proposed change</summary> ```diff 1. Reporting bugs 2. Suggesting new features or improvements -3. Improving documentation +3. Contributing to documentation 4. Fixing existing issues 5. Reviewing pull requests
76-80: Provide specific, actionable Getting Help resources.The "Getting Help" section lists contact methods but lacks URLs or actionable details (e.g., Discord server invite link, discussions repository section). Include direct links or clear navigation steps so contributors know exactly where to go.
🔎 Proposed enhancement
## Getting Help If you need help: -1. Join our Discord -2. Use GitHub Discussions -3. Ask in the issue you are working on +1. Join our [Discord community](#) (link TBD) +2. Start a [GitHub Discussion](#) (link TBD) +3. Comment on the [issue](https://github.com/AOSSIE-Org/Devr.AI/issues) you are working on
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
CONTRIBUTING.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
CONTRIBUTING.md
[style] ~18-~18: Consider using a different verb for a more formal wording.
Context: ...rovements 3. Improving documentation 4. Fixing existing issues 5. Reviewing pull reque...
(FIX_RESOLVE)
1 participant
What
Adds a CONTRIBUTING.md file to provide clear contribution guidelines for new contributors.
Why
The repository currently does not have a CONTRIBUTING.md, which can confuse first-time contributors. This improves onboarding and contribution quality.
How
Closes #162
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.