-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
64 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
# 🌍 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: | ||
|
||
```sh | ||
git clone git@github.com:your_name_here/the-algorithm-ml.git | ||
``` | ||
|
||
3. Navigate to the recently created directory: | ||
|
||
```sh | ||
cd the-algorithm-ml | ||
``` | ||
|
||
4. Install Required dependencies: | ||
|
||
```sh | ||
pip install --no-deps -r images/requirements.txt | ||
``` | ||
|
||
5. Work on your local changes. | ||
|
||
6. Test your local changes: | ||
|
||
```sh | ||
pytest -vv | ||
``` | ||
|
||
6. Install `pre-commit` as a git hook: | ||
|
||
```sh | ||
pre-commit install | ||
``` | ||
|
||
7. Create a branch for local development: | ||
|
||
```sh | ||
git checkout -b name-of-your-bugfix-or-feature | ||
``` | ||
|
||
8. Commit your changes and push your branch to GitHub: | ||
|
||
```sh | ||
git add . | ||
git commit -m "Your detailed description of your changes." | ||
git push origin name-of-your-bugfix-or-feature | ||
``` | ||
|
||
6. Submit a pull request through the GitHub website. | ||
|
||
## 📙 Pull Request Guidelines. | ||
|
||
Before you submit a pull request, check that it meets these guidelines: | ||
|
||
1. The pull request should include tests, if applicable. | ||
|
||
Thank you for helping us improve! |