Skip to content

Latest commit

 

History

History
92 lines (67 loc) · 2.83 KB

CONTRIBUTING.md

File metadata and controls

92 lines (67 loc) · 2.83 KB

Contributing to ChatBot

Thank you for considering contributing to ChatBot! We welcome contributions big and small—bug reports, feature suggestions, documentation improvements, tests, or code.

Table of Contents

  1. Code of Conduct
  2. How Can I Contribute?
  3. Getting Started
  4. Branching & Workflow
  5. Pull Request Process
  6. Style Guidelines
  7. Tests & Quality
  8. License & Contributor Agreement
  9. Communication Channels

Code of Conduct

Please note we follow the Code of Conduct in all interactions. By participating, you are expected to honor this.

How Can I Contribute?

We accept all kinds of contributions, including:

  • 🐛 Report bugs
  • 🌱 Suggest new features or enhancements
  • 🔧 Submit pull requests with fixes or improvements
  • 📄 Improve documentation or examples
  • 🚀 Help with tests or automated tooling

Getting Started

To contribute code:

  1. Fork the repository.
  2. Clone your fork locally: 
    git clone https://github.com/your-username/ChatBot.git
cd ChatBot
git remote add upstream https://github.com/ob-labs/ChatBot.git
  3. Create a branch for your feature/fix: 
    git checkout -b feature/your-feature-name
  4. Make your changes.
  5. Make sure everything passes tests and lints.
  6. Push your branch to your fork: 
    git push origin feature/your-feature-name

Branching & Workflow

  • Development usually happens on main branch and feature branches.
  • Before creating your PR:
    • Pull the latest from upstream main.
    • Rebase or merge to resolve conflicts.

Pull Request Process

When you're ready:

  • Open a PR against the main branch.
  • Fill out the PR template (if available).
  • Describe what you've changed and why.
  • Make sure tests pass & CI checks succeed.
  • A maintainer will review, provide feedback, and merge if everything looks good.

Style Guidelines

  • Follow existing code style (indentation, naming, etc.).
  • Write clear & descriptive commit messages.
  • Document any new public API changes.
  • Include unit tests for new functionality.

Tests & Quality

  • Make sure you run tests locally before submitting.
  • Add tests covering your changes.
  • Tests should pass under CI.

License & Contributor Agreement

By contributing, you agree that your contributions will be licensed under the MIT License and you grant the project maintainers the right to use your contributions under that license.

Communication Channels

  • Use GitHub issues & pull requests for discussions.
  • Contact project maintainers via GitHub issues for questions or larger discussions.

Thank you for your contributions ✨