Skip to content

Contributing

Thank you for considering contributing to ConfigConverter!

How to Contribute

  1. Fork the Repository: Click on the "Fork" button at the top right of the repository page.

  2. Clone Your Fork:

git clone https://github.com/ankit-aglawe/configconverter.git
  1. Create a Branch:
git checkout -b feature/your-feature-name
  1. Make Your Changes: Implement your feature or bug fix.

  2. Write Tests: Ensure your changes are covered by tests.

  3. Commit Your Changes:

git commit -am 'Add new feature'
  1. Push to Your Fork:
git push origin feature/your-feature-name
  1. 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.