-
-
Notifications
You must be signed in to change notification settings - Fork 160
Add CONTRIBUTING.md with step-by-step guide #126
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
Closed
shivansh31414
wants to merge
5
commits into
AOSSIE-Org:main
from
shivansh31414:docs/contributing-guide
Closed
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
93fa98f
Add CONTRIBUTING.md with step-by-step guide
2e56672
Add SECURITY.md and ISSUE_TEMPLATE.md for vulnerability reporting and…
0a54761
Add SECURITY.md and ISSUE_TEMPLATE.md for vulnerability reporting and…
e758e15
Create ISSUE_TEMPLATE.md for issue reporting
shivansh31414 523f20d
Create SECURITY.md for vulnerability reporting guidelines
shivansh31414 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Empty file.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
|
|
||
|
|
||
| # Code of Conduct | ||
|
|
||
| We are committed to fostering an open and welcoming environment. | ||
|
|
||
| ## Our Standards | ||
| - Be respectful and inclusive. | ||
| - Use welcoming and professional language. | ||
| - Accept constructive criticism gracefully. | ||
| - Focus on collaboration and learning. | ||
|
|
||
| ## Unacceptable Behavior | ||
| - Harassment, discrimination, or offensive comments. | ||
| - Publishing private information without consent. | ||
| - Disruptive or hostile conduct. | ||
|
|
||
| ## 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. | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
|
|
||
|
|
||
|
|
||
| # Contributing to DebateAI | ||
|
|
||
| We welcome contributions! Please follow these steps to ensure smooth collaboration. | ||
|
|
||
| ## Getting Started | ||
|
|
||
| 1. **Fork the Repository** | ||
| Click the Fork button on GitHub and clone your fork: | ||
| ```bash | ||
| git clone https://github.com/your-username/DebateAI.git | ||
| cd DebateAI | ||
| ``` | ||
|
|
||
| 2. **Create a Branch** | ||
| ```bash | ||
| git checkout -b feature-name | ||
| ``` | ||
|
|
||
| 3. **Make Changes** | ||
| - Follow coding best practices. | ||
| - Keep commits atomic and messages clear. | ||
|
|
||
| 4. **Commit & Push** | ||
| ```bash | ||
| git commit -m "Added [feature/fix]: Short description" | ||
| git push origin feature-name | ||
| ``` | ||
|
|
||
| 5. **Open a Pull Request (PR)** | ||
| - Provide a detailed description of your changes. | ||
| - Link related issues (e.g., `Closes #23`). | ||
|
|
||
| ## Best Practices | ||
|
|
||
| - **Code Quality**: Ensure your code is clean, readable, and consistent. | ||
| - **Testing**: Verify changes locally before submitting. | ||
| - **Security**: Never commit sensitive information (API keys, passwords, etc.). | ||
| - **Communication**: Be responsive to reviews and open to feedback. | ||
|
|
||
| --- | ||
|
|
||
| Thank you for helping improve DebateAI! 🚀 | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| # DebateAI | ||
|
|
||
| DebateAI is an AI‑enhanced, real‑time debating platform designed to sharpen communication skills. | ||
| Users can compete against human opponents or AI challengers in structured formats that mimic formal competitions. | ||
|
|
||
| ## Why It Exists | ||
| Many learners and professionals want to practice persuasive communication but lack accessible, interactive platforms. | ||
| DebateAI bridges this gap by combining real‑time debate mechanics with adaptive AI counterarguments. | ||
|
|
||
| ## Key Features | ||
| - **User vs. User Debates**: Real‑time debates via WebSockets and WebRTC (audio/video/text). | ||
| - **User vs. AI Debates**: LLM‑generated counterarguments that adapt to your input. | ||
| - **Structured Formats**: Opening, cross‑exam, and closing rounds. | ||
| - **Custom Debate Rooms**: Private, topic‑specific spaces for focused practice. | ||
|
|
||
| ## Vision | ||
| We aim to democratize debate practice, making it engaging, scalable, and accessible to anyone who wants to improve their communication skills. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| # Issue Template | ||
|
|
||
| ## Description | ||
| Briefly describe the problem or feature request. | ||
|
|
||
| ## Steps to Reproduce (if bug) | ||
| 1. Step one | ||
| 2. Step two | ||
| 3. ... | ||
|
|
||
| ## Expected Behavior | ||
| What should happen? | ||
|
|
||
| ## Actual Behavior | ||
| What actually happens? | ||
|
|
||
| ## Environment | ||
| - OS: | ||
| - Browser: | ||
| - Backend/Frontend version: | ||
|
|
||
| ## Additional Context | ||
| Add screenshots, logs, or references if available. | ||
shivansh31414 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| # Pull Request Template | ||
|
|
||
| ## Description | ||
| Explain what this PR changes and why. | ||
|
|
||
| ## Related Issue(s) | ||
| Closes # (issue number) | ||
|
|
||
| ## Checklist | ||
| - [ ] Code follows project style guidelines | ||
| - [ ] Tests added or updated | ||
| - [ ] Documentation updated | ||
| - [ ] No sensitive information committed | ||
|
|
||
| ## Screenshots (if applicable) | ||
| Add before/after visuals or demo links. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| # Security Policy | ||
|
|
||
| We take security seriously. Please follow these guidelines when reporting vulnerabilities. | ||
|
|
||
| ## Reporting a Vulnerability | ||
| - use GitHub Security tab | ||
| - Include steps to reproduce, impact, and potential fixes. | ||
| - Do not disclose publicly until maintainers confirm a resolution. | ||
|
|
||
| ## Response Timeline | ||
| - Acknowledge receipt within 48 hours. | ||
| - Provide status updates within 7 days. | ||
| - Aim to release fixes promptly. | ||
|
|
||
| ## Scope | ||
| - Vulnerabilities in DebateAI backend, frontend, or deployment scripts. | ||
| - Issues affecting user data, authentication, or debate integrity. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
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:
Note: Replace
conduct@DebateAI.organd the email address with actual project contact information.📝 Committable suggestion