Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Empty file added .gitattributes
Empty file.
22 changes: 22 additions & 0 deletions CODE_OF_CONDUCT.md
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.
Comment on lines +18 to +21
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

Clarify enforcement reporting mechanism and process.

The Enforcement section is incomplete in two ways:

  1. 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.

  2. 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.

Suggested change
## 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.


46 changes: 46 additions & 0 deletions CONTRIBUTING.md
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! 🚀
```
17 changes: 17 additions & 0 deletions DESCRIPTION.md
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.
23 changes: 23 additions & 0 deletions ISSUE_TEMPLATE.md
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.
16 changes: 16 additions & 0 deletions PULL_REQUEST_TEMPLATE.md
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.
17 changes: 17 additions & 0 deletions SECURITY.md
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.