Skip to content

Contributing to pynvl

This project is still early stage and contributions of all kinds are welcome.

🔹 How to Contribute

  1. Fork the repository
    Click the Fork button on GitHub and clone your fork. bash git clone https://github.com/<your-username>/pynvl_project.git cd pynvl

  2. Create a feature branch
    Click the Fork button on GitHub and clone your fork. bash git checkout -b feature/my-feature

  3. Install dependencies in a virtual environment
    bash python -m venv .venv .venv\Scripts\activate # Windows pip install -r requirements-dev.txt # if available

  4. Run tests
    Click the Fork button on GitHub and clone your fork. bash pytest tests/

  5. Commit your changes
    Click the Fork button on GitHub and clone your fork. bash git add . git commit -m "Add: short description of change" git push origin feature/my-feature

  6. Open a Pull Request
    Go to GitHub and open a PR against the main branch.

🔹Other Notes

  • Use pytest for all tests and place tests under tests directory
  • Add examples if your change affects usage! Documentation is in docs/ folder.
  • Use Python 3.10+
  • Report any bugs
  • Run mkdocs serve locally to preview changes.
  • Suggest any new helper functions
  • You agree that your contributions fall under the same MIT licence as the project.