Contributing¶
Thank you for considering contributing to ConfigConverter!
How to Contribute¶
-
Fork the Repository: Click on the "Fork" button at the top right of the repository page.
-
Clone Your Fork:
git clone https://github.com/ankit-aglawe/configconverter.git
- Create a Branch:
git checkout -b feature/your-feature-name
-
Make Your Changes: Implement your feature or bug fix.
-
Write Tests: Ensure your changes are covered by tests.
-
Commit Your Changes:
git commit -am 'Add new feature'
- Push to Your Fork:
git push origin feature/your-feature-name
- Submit a Pull Request: Go to the original repository and submit a pull request.
Code Style¶
- Follow PEP 8 guidelines.
- Use type hints where appropriate.
- Write docstrings for all public modules, classes, and functions.
Reporting Issues¶
If you encounter any issues, please open an issue on GitHub with detailed information.