Thank you for considering contributing! We welcome bug reports, feature requests, documentation improvements, and code contributions.
- Fork the repository on GitHub.
- Clone your fork:
git clone https://github.com/reprompts/gitstarter.git cd gitstarter
Create a branch for your change:
git checkout -b feature/my-new-feature Install dependencies:
pip install -r requirements.txt Make your changes. Ensure you update documentation when necessary.
Run the app to test: gitstarter
Commit and push your branch:
git add . git commit -m "Describe your change" git push origin feature/my-new-feature
Open a Pull Request against main.
Contribution types Bug fixes: Please include steps to reproduce the issue.
Features: Describe the user workflow and UI changes.
Documentation: Clarify README, add examples, fix typos.
Tests: Add tests in tests/ directory; we use pytest.
Code style Follow PEP8 guidelines.
Use f-strings for formatting.
Keep functions small and focused.
Review process PRs are reviewed by maintainers.
Please respond to feedback and update your PR.
Once approved, your PR will be merged.
Thank you for helping make gitstarter better!