Thank you for your interest in contributing to Chess Agent! This document provides guidelines and instructions for contributing to the project.
Please be respectful and considerate of others when contributing to this project.
If you find a bug, please open an issue on GitHub with the following information:
- A clear and descriptive title.
- Steps to reproduce the bug.
- Expected behavior and actual behavior.
- Any relevant logs or screenshots.
If you have an idea for an enhancement, please open an issue on GitHub with the following information:
- A clear and descriptive title.
- A detailed description of the enhancement.
- Any relevant examples or mockups.
-
Fork the Repository: Start by forking the repository to your GitHub account.
-
Create a Branch: Create a new branch for your feature or bugfix:
git checkout -b feature/your-feature-name
-
Make Changes: Make your changes and ensure they are well-documented and tested.
-
Commit Changes: Commit your changes with a clear and descriptive commit message:
git commit -m "Add your feature" -
Push Changes: Push your changes to your fork:
git push origin feature/your-feature-name
-
Submit a Pull Request: Open a pull request from your fork to the main repository. Ensure your pull request includes:
- A clear and descriptive title.
- A detailed description of the changes.
- Any relevant issue numbers.
-
Review and Merge: Once your pull request is reviewed and approved, it will be merged into the main repository.
-
Clone the repository:
git clone https://github.com/rishimule/chess_agent.git cd chess_agent -
Create a virtual environment and activate it:
python -m venv venv source venv/bin/activate # On Windows, use `venv\Scripts\activate`
-
Install the package in development mode:
pip install -e . -
Install test dependencies:
pip install -r tests/requirements.txt
-
Run the tests to ensure everything is working:
PYTHONPATH=src python -m pytest tests/ -v
- Follow PEP 8 guidelines for Python code.
- Use meaningful variable and function names.
- Comment your code where necessary.
By contributing to Chess Agent, you agree that your contributions will be licensed under the project's MIT License.