the-algorithm-ml/CONTRIBUTING.md

🌍 Contributing.

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

👶 Getting Started!

Ready to contribute? Here's how to set up the-algorithm-ml for local development.

1. Fork the the-algorithm-ml repo on GitHub.
2. Clone your fork locally:

git clone git@github.com:your_name_here/the-algorithm-ml.git

3. Navigate to the recently created directory:

cd the-algorithm-ml

4. Install all required dependencies:

pip install --no-deps -r images/requirements.txt

5. Work on your local changes.

6. Test your local changes:

pytest -vv

7. Install pre-commit as a git hook:

pre-commit install

8. Create a branch for local development:

git checkout -b name-of-your-bugfix-or-feature

9. Commit your changes and push your branch to GitHub:

git add .
git commit -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature

10. Submit a pull request through the GitHub website.

📙 Pull Request Guidelines.

Before you submit a pull request, check that it meets these guidelines:

1. You must sign our CLA (Contributor License Agreement) upon opening a PR.
2. The pull request should include tests, if applicable.

Thank you for helping us improve!