Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
34 lines (21 loc) · 840 Bytes

CONTRIBUTING.md

File metadata and controls

34 lines (21 loc) · 840 Bytes
Raw

Contributing to Prompt Versioner

Thanks for wanting to contribute! Follow these simple steps:

1️⃣ Fork & Branch

  • Fork the repo.
  • Create a feature branch: feature/your-feature or fix/bug-name.

2️⃣ Make Changes

  • Implement new features or fix bugs.
  • Follow the existing code style (e.g., use Black).
  • Update documentation if needed.

3️⃣ Testing

  • Run tests locally to ensure nothing breaks.
  • Add tests for new functionality or bug fixes.

4️⃣ Submit PR

  • Open a pull request to main.
  • Include a clear description of what you changed and why.

5️⃣ Tools & Tips

  • Poetry → manage dependencies & virtual environment.
  • Pre-commit hooks → auto-check code before commits.
  • Docs → located in the docs folder.

6️⃣ License