Add CONTRIBUTING.md with step-by-step guide#126
Add CONTRIBUTING.md with step-by-step guide#126shivansh31414 wants to merge 5 commits intoAOSSIE-Org:mainfrom
Conversation
WalkthroughAdds repository governance and contributor documentation: new markdown files for Code of Conduct, Contributing guidelines, project Description, Issue template, Pull Request template, and a Security policy — all new docs establishing standards, templates, and onboarding instructions. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Possibly related PRs
Poem
Pre-merge checks and finishing touches✅ Passed checks (5 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (4)
DESCRIPTION.md (1)
17-17: Strengthen the closing statement for engagement.Consider replacing "wants to improve" with a more dynamic verb to enhance reader engagement. For instance: "seeks to enhance," "strives to master," or "aims to perfect."
Example revision:
-We aim to democratize debate practice, making it engaging, scalable, and accessible to anyone who wants to improve their communication skills. +We aim to democratize debate practice, making it engaging, scalable, and accessible to anyone who seeks to master their communication skills.CONTRIBUTING.md (2)
1-3: Remove leading blank lines.Lines 1–3 contain unnecessary leading blank lines. These should be removed for a cleaner document start.
- - - # Contributing to DebateAI
19-20: Expand branch naming convention guidance (optional).The example uses
feature-name, but contributors may benefit from guidance on naming patterns for different change types (e.g.,bugfix/,docs/,hotfix/). This is optional but helps maintain consistency.Example enhancement:
2. **Create a Branch** ```bash - git checkout -b feature-name + git checkout -b feature-name # or bugfix/, docs/, hotfix/, etc.</blockquote></details> <details> <summary>CODE_OF_CONDUCT.md (1)</summary><blockquote> `1-2`: **Remove leading blank lines (consistent with other docs).** Lines 1–2 contain unnecessary leading blank lines that should be removed for consistency with documentation style. ```diff - - # Code of Conduct
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
CODE_OF_CONDUCT.md(1 hunks)CONTRIBUTING.md(1 hunks)DESCRIPTION.md(1 hunks)PULL_REQUEST_TEMPLATE.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
DESCRIPTION.md
[style] ~17-~17: Try replacing commonly used words with synonyms to make your writing more engaging.
Context: ..., and accessible to anyone who wants to improve their communication skills.
(IMPROVE_STRENGTHEN)
🔇 Additional comments (2)
PULL_REQUEST_TEMPLATE.md (1)
1-16: Well-structured template aligned with contribution guidelines.The template provides a clear structure that aligns with CONTRIBUTING.md recommendations and includes all essential elements: description, issue linking, verification checklist, and optional visuals. The checklist items (code quality, tests, documentation, security) are appropriately scoped.
CONTRIBUTING.md (1)
38-41: LGTM on best practices section.The Best Practices section covers key areas: code quality, testing, security, and communication. The guidance is clear and appropriately scoped for contributor onboarding.
| ## Enforcement | ||
| - Report violations via GitHub Issues or email (maintainers will provide contact). | ||
| - Maintainers will review and act fairly. | ||
| - Consequences may include warnings, temporary bans, or permanent removal. |
There was a problem hiding this comment.
Clarify enforcement reporting mechanism and process.
The Enforcement section is incomplete in two ways:
-
Line 19: "maintainers will provide contact" is circular—this IS the maintainer communication channel. Provide an actual email address or point to a specific issues template/label.
-
Lines 18–21: The process lacks detail on review timeline, escalation path, and appeals mechanism. Consider adding expected response time and clarity on consequences.
Example enhancement:
## Enforcement
- Report violations via GitHub Issues (use label: `code-of-conduct`) or email: conduct@DebateAI.org
- Maintainers will review within 5 business days and act fairly.
- Consequences may include: warnings, temporary bans (1 month+), or permanent removal.
- Appeals can be submitted to [maintainers email] with additional context.Note: Replace conduct@DebateAI.org and the email address with actual project contact information.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ## Enforcement | |
| - Report violations via GitHub Issues or email (maintainers will provide contact). | |
| - Maintainers will review and act fairly. | |
| - Consequences may include warnings, temporary bans, or permanent removal. | |
| ## Enforcement | |
| - Report violations via GitHub Issues (use label: `code-of-conduct`) or email: conduct@DebateAI.org | |
| - Maintainers will review within 5 business days and act fairly. | |
| - Consequences may include: warnings, temporary bans (1 month+), or permanent removal. | |
| - Appeals can be submitted to [maintainers email] with additional context. |
Add a structured issue template for reporting bugs or feature requests.
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
ISSUE_TEMPLATE.md (1)
6-9: Consider separate templates for bug reports vs. feature requests.The "Steps to Reproduce (if bug)" phrasing suggests this template is primarily for bugs, but feature requests are equally important. If you want a single template, consider rewording this section to be more generic; otherwise, add separate templates:
.github/ISSUE_TEMPLATE/bug_report.md.github/ISSUE_TEMPLATE/feature_request.mdThis is optional if a single template is preferred, but it improves clarity and UX for contributors.
Added a security policy document outlining guidelines for reporting vulnerabilities and response timelines.
|
Already exists |
2 participants
Description
This PR adds core documentation files to improve contributor onboarding and community clarity.
Specifically, it introduces:
DESCRIPTION.md→ Overview of DebateAI, its purpose, and vision.CONTRIBUTING.md→ Step‑by‑step guide for new contributors.CODE_OF_CONDUCT.md→ Standards for respectful collaboration.PULL_REQUEST_TEMPLATE.md→ Checklist and structure for consistent PRs.Motivation
Clear documentation is essential for open source collaboration. These files:
Changes Made
.mdfiles in the repo root.ISSUE_TEMPLATE.mdandSECURITY.md(to be added separately).Related Issue
Closes #23
Checklist
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.