Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
108 lines (70 loc) · 2.17 KB

CONTRIBUTING.md

File metadata and controls

108 lines (70 loc) · 2.17 KB
# Contributing to ChaxAI

First off, thanks for taking the time to contribute to **ChaxAI**! 🎉  
We appreciate your interest in improving this project and welcome all forms of contributions — whether it's fixing bugs, improving documentation, adding new features, or helping others.

---

## 🧰 Getting Started

1. **Fork** the repository on GitHub.
2. **Clone** your fork:

   ```bash
   git clone https://github.com/your-username/ChaxAI.git
   cd ChaxAI

  1. Create a new branch for your changes:

    git checkout -b feature/your-feature-name

  2. Install dependencies:

    pip install -r requirements.txt

  3. Make your changes and commit:

    git commit -am "Add your detailed message here"

  4. Push your branch and create a Pull Request:

    git push origin feature/your-feature-name

📌 Contribution Types

Here are a few ways you can contribute:

  • 🐛 Bug Fixes
  • 📝 Improve Documentation
  • 🌟 Add New Features
  • 🚧 Refactor or Optimize Code
  • 🧪 Add or Fix Tests
  • 🌍 Internationalization / i18n
  • 💬 Provide Feedback, Ideas, or Discussion Topics

📄 Code Style & Practices

  • Follow PEP8 (Python) and Prettier (JS/TS) standards.
  • Use meaningful commit messages.
  • Include docstrings and inline comments where appropriate.
  • Keep PRs focused and minimal — avoid bundling unrelated changes.

🧪 Running Tests (Coming Soon)

When tests are implemented, run:

pytest

Ensure your code passes before submitting PRs.

🤝 Code of Conduct

This project follows a Code of Conduct. Be kind, respectful, and constructive. We're building a welcoming open-source community.

💬 Need Help?

  • Open an issue with the question label.
  • Join future discussions on GitHub Discussions (coming soon).

Thank you again for being a part of ChaxAI! Happy coding! 🚀

🐳 Using Docker

If you prefer running the project in containers, build and start the stack with:

docker-compose build
docker-compose up

This will run both the backend and frontend services.