Skip to content

Latest commit

 

History

History
123 lines (93 loc) · 3.22 KB

CONTRIBUTING.md

File metadata and controls

123 lines (93 loc) · 3.22 KB

Here’s a well-structured CONTRIBUTING.md for your project:

Contributing to ChatsAPI

Thank you for considering contributing to the ChatsAPI project! Your support and contributions help make this project better for everyone. This document outlines the process to help you get started.

How Can You Contribute?

We welcome contributions in the following areas:

  • Bug reports and fixes.
  • Feature requests and ideas.
  • Improving documentation.
  • Optimizing performance.
  • Writing tests to improve reliability.
  • Reviewing and providing feedback on existing issues or pull requests.

Getting Started

1. Fork the Repository

  1. Navigate to the ChatsAPI GitHub repository.
  2. Click on the "Fork" button in the top-right corner to create a copy of the repository under your GitHub account.

2. Clone the Repository

Clone your forked repository to your local machine:

git clone https://github.com/<your-username>/ChatsAPI.git
cd ChatsAPI

3. Set Up the Development Environment

Ensure you have Python installed. Then, set up the environment:

python -m venv env
source env/bin/activate  # For macOS/Linux
env\Scripts\activate     # For Windows
pip install -r requirements.txt

4. Run the Tests

Make sure all existing tests pass before making changes:

pytest

How to Contribute

Reporting Issues

If you’ve found a bug or want to suggest a feature:

  1. Search the existing issues to avoid duplicates.
  2. Create a new issue, providing:
    • A clear title and description.
    • Steps to reproduce (for bugs).
    • A proposal or context (for features).

Submitting Pull Requests

  1. Create a new branch for your work: 
    git checkout -b feature/your-feature-name
  2. Make your changes and commit them: 
    git add .
git commit -m "Add a brief description of the changes"
  3. Push the changes to your fork: 
    git push origin feature/your-feature-name
  4. Open a Pull Request on the main repository:
    • Provide a detailed description of your changes.
    • Link any relevant issues your PR addresses.

Code Guidelines

  • Follow PEP 8 for Python code style.
  • Use descriptive variable names and write clear comments where necessary.
  • Add tests for any new features or bug fixes.
  • Avoid introducing breaking changes without discussion.

Commit Message Format

Use the following format for commit messages:

[TYPE]: Brief description of your changes

Details about the change, if necessary.

Examples of TYPE:

  • feat: A new feature.
  • fix: A bug fix.
  • docs: Documentation changes.
  • test: Adding or updating tests.
  • refactor: Code refactoring.

Community Guidelines

  • Be respectful and kind when interacting with others.
  • Provide constructive feedback during reviews.
  • Avoid spamming or creating off-topic discussions.

Questions or Help?

If you have questions about contributing, feel free to:

We’re excited to have you as part of the community! 🎉