Skip to content

Commit 2836273

Browse files
authored
Add development setup guidelines (#32)
1 parent d1ab150 commit 2836273

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

CONTRIBUTION.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
## Contributing Guidelines
2+
<hr>
23

34
Thank you for considering contributing to our project! We welcome contributions from everyone. To maintain a positive and collaborative environment, please follow these guidelines:
45

56
### Creating Issues:
7+
<hr>
68

79
1. **Search Existing Issues**: Before creating a new issue, please search existing issues to see if the topic has already been discussed or reported.
810

@@ -12,7 +14,23 @@ Thank you for considering contributing to our project! We welcome contributions
1214

1315
4. **Use Labels**: Use appropriate labels to categorize your issue (e.g., bug, enhancement, documentation, etc.).
1416

17+
### Development Setup:
18+
<hr>
19+
20+
1. Fork and clone the Repository
21+
2. Pull latest changes from the main repository if it has diverged
22+
3. [Create a virtual environment for the project](https://docs.python.org/3/library/venv.html)
23+
4. Install dependencies using `pip install -r requirements.txt`
24+
5. Install pre-commit hook using `pre-commit install`
25+
6. Run tests using `pytest tests/test_file_name.py ` or specific test name like `pytest tests/test_file_name.py::test_function_name`
26+
7. Do not push changes without the tests and coverage passing
27+
8. Commit your changes with **proper** commit messages in imperative form like `Add my best feature`, `Fix issues casusing whatever`, `Update docs` etc: [Good reference here](https://cbea.ms/git-commit/)
28+
9. Make changes and push to your forked repository
29+
10. Create PR to the forked repository as mentioned below
30+
31+
1532
### Pull Requests (PRs):
33+
<hr>
1634

1735
1. **Fork the Repository**: Start by forking the repository to your GitHub account.
1836

0 commit comments

Comments
 (0)