Skip to content

Latest commit

 

History

History
89 lines (63 loc) · 2.23 KB

getting-started.rst

File metadata and controls

89 lines (63 loc) · 2.23 KB
Raw

Getting started with evalg

Codestyle

Codestyle is not strictly enforced.

  • Write pretty code
  • Never use tab indents in python code
  • Follow PEPs to the best of your ability (PEP-8, PEP-257)
  • Docstrings should work with sphinx

Apply all the linters! This author recommends running flake8 with plugins: naming, pycodestyle, pyflakes.

Testing

Testing in evalg is done using the pytest framework along with pytest-flask and several other extensions.

  • Unit tests live under the tests/ directory
  • Tests run using pytest, typically invoked using tox
# Run tests using tox
tox
python -m tox

# Run tests using pytest
pytest
python -m pytest

Versioning

Versioning is done by tagging git commits and is automatically picked up by setuptools_scm.

Note

The first stable release of this software will become evalg v3.0, as v2.x refers to an older implementation of electronic voting.

Version tags should start with the letter v (for version), and then follow the syntax of PEP-440, normally vX.Y.Z, where here X, Y and Z are numbers, Y and Z being optional. Optionally, we can use the «aN», «bN» or «rcN» and the other possibilities in PEP-440. Versions should follow semantic versioning guidelines.

Contribution guidelines

TODO: Make a CONTRIBUTE.rst in the root, and include?

References

3rd party documentation