From 93fa98f5379d25d887fa8674b9716366093509fd Mon Sep 17 00:00:00 2001 From: Shivansh Date: Tue, 2 Dec 2025 19:02:00 +0530 Subject: [PATCH 1/5] Add CONTRIBUTING.md with step-by-step guide --- CODE_OF_CONDUCT.md | 22 +++++++++++++++++++ CONTRIBUTING.md | 46 ++++++++++++++++++++++++++++++++++++++++ DESCRIPTION.md | 17 +++++++++++++++ PULL_REQUEST_TEMPLATE.md | 16 ++++++++++++++ 4 files changed, 101 insertions(+) create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md create mode 100644 DESCRIPTION.md create mode 100644 PULL_REQUEST_TEMPLATE.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..898c132 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -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. + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..a673e0d --- /dev/null +++ b/CONTRIBUTING.md @@ -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! 🚀 +``` \ No newline at end of file diff --git a/DESCRIPTION.md b/DESCRIPTION.md new file mode 100644 index 0000000..43f2945 --- /dev/null +++ b/DESCRIPTION.md @@ -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. diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..c57b73b --- /dev/null +++ b/PULL_REQUEST_TEMPLATE.md @@ -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. From 2e566727edd63568ffe58a0d40ecafd78c06c5eb Mon Sep 17 00:00:00 2001 From: Shivansh Date: Mon, 8 Dec 2025 17:25:21 +0530 Subject: [PATCH 2/5] Add SECURITY.md and ISSUE_TEMPLATE.md for vulnerability reporting and issue structure --- ISSUE_TEMPLATE.md | 0 SECURITY.md | 0 2 files changed, 0 insertions(+), 0 deletions(-) create mode 100644 ISSUE_TEMPLATE.md create mode 100644 SECURITY.md diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..e69de29 diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..e69de29 From 0a5476122496c651f2e60efd3f3da739799ac6f6 Mon Sep 17 00:00:00 2001 From: Shivansh Date: Mon, 8 Dec 2025 17:27:49 +0530 Subject: [PATCH 3/5] Add SECURITY.md and ISSUE_TEMPLATE.md for vulnerability reporting and issue structure --- .gitattributes | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 .gitattributes diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..e69de29 From e758e15af175873e15f6ea36e69bb5869e9563bd Mon Sep 17 00:00:00 2001 From: Shivansh Sharma Date: Mon, 8 Dec 2025 17:32:39 +0530 Subject: [PATCH 4/5] Create ISSUE_TEMPLATE.md for issue reporting Add a structured issue template for reporting bugs or feature requests. --- ISSUE_TEMPLATE.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index e69de29..ba8b3c8 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -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. From 523f20d81c2a0e7e3d79da600875b4f343be3b3a Mon Sep 17 00:00:00 2001 From: Shivansh Sharma Date: Mon, 8 Dec 2025 17:35:35 +0530 Subject: [PATCH 5/5] Create SECURITY.md for vulnerability reporting guidelines Added a security policy document outlining guidelines for reporting vulnerabilities and response timelines. --- SECURITY.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/SECURITY.md b/SECURITY.md index e69de29..0e1f10a 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -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.