Skip to content

Commit 6ea98a5

Browse files
Create CONTRIBUTING.md with contribution instructions
Added contributing guidelines for the project.
1 parent c52c978 commit 6ea98a5

1 file changed

Lines changed: 28 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Contributing
2+
3+
Thank you for your interest in this project!
4+
5+
## How to Contribute
6+
7+
1. Fork the repository
8+
2. Create a new branch (`git checkout -b feature/your-feature`)
9+
3. Make your changes
10+
4. Run the test suite (`pytest tests/ -v`)
11+
5. Commit your changes (`git commit -m "Add your feature"`)
12+
6. Push to the branch (`git push origin feature/your-feature`)
13+
7. Open a Pull Request
14+
15+
## Running Tests
16+
```bash
17+
pytest tests/ -v
18+
```
19+
20+
## Code Style
21+
22+
- Follow PEP 8 for Python code
23+
- Add docstrings to all functions
24+
- Ensure all tests pass before submitting a PR
25+
26+
## Questions
27+
28+
Feel free to reach out via [LinkedIn](https://www.linkedin.com/in/anandirm/)

0 commit comments

Comments
 (0)