Skip to content

Latest commit

 

History

History
30 lines (22 loc) · 1.16 KB

File metadata and controls

30 lines (22 loc) · 1.16 KB

Contributing to Virtaal

Thanks for considering contributing! The short version:

  1. Check open issues and open pull requests first, so you're not duplicating someone else's work.
  2. Fork the repo, make your change on a branch, and open a pull request.
  3. For anything non-trivial, an issue describing what you're planning before you start is welcome, but not required.

Building and testing

See docs/building.rst for how to get a working checkout, and docs/testing.rst for how to run the test suite. Keep detailed setup/build instructions in docs/, not here - this file is meant to stay a short, high-level "how to get involved" pointer.

Hygiene checks

See docs/development.rst for setting up prek (or pre-commit) so basic checks run before each commit, rather than only finding out after pushing.

Translations

Translating Virtaal's own interface into your language doesn't need any of the above - see docs/localising_virtaal.rst.