File tree Expand file tree Collapse file tree 1 file changed +64
-0
lines changed Expand file tree Collapse file tree 1 file changed +64
-0
lines changed Original file line number Diff line number Diff line change 1+ # 🌍 Contributing.
2+
3+ Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
4+
5+ ## 👶 Getting Started!
6+
7+ Ready to contribute? Here's how to set up ` the-algorithm-ml ` for local development.
8+
9+ 1 . Fork the ` the-algorithm-ml ` repo on GitHub.
10+ 2 . Clone your fork locally:
11+
12+ ``` sh
13+ git clone
[email protected] :your_name_here/the-algorithm-ml.git
14+ ```
15+
16+ 3 . Navigate to the recently created directory:
17+
18+ ``` sh
19+ cd the-algorithm-ml
20+ ```
21+
22+ 4 . Install Required dependencies:
23+
24+ ``` sh
25+ pip install --no-deps -r images/requirements.txt
26+ ```
27+
28+ 5 . Work on your local changes.
29+
30+ 6 . Test your local changes:
31+
32+ ``` sh
33+ pytest -vv
34+ ```
35+
36+ 7 . Install ` pre-commit ` as a git hook:
37+
38+ ``` sh
39+ pre-commit install
40+ ```
41+
42+ 8 . Create a branch for local development:
43+
44+ ``` sh
45+ git checkout -b name-of-your-bugfix-or-feature
46+ ```
47+
48+ 9 . Commit your changes and push your branch to GitHub:
49+
50+ ``` sh
51+ git add .
52+ git commit -m " Your detailed description of your changes."
53+ git push origin name-of-your-bugfix-or-feature
54+ ```
55+
56+ 10 . Submit a pull request through the GitHub website.
57+
58+ ## 📙 Pull Request Guidelines.
59+
60+ Before you submit a pull request, check that it meets these guidelines:
61+
62+ 1 . The pull request should include tests, if applicable.
63+
64+ Thank you for helping us improve!
You can’t perform that action at this time.
0 commit comments