Development practises

Code

Follow general PEP 8 conventions: 4 space indent, CamelCase classes, lower_case_with_underscores for functions, methods and variables, UPPER_CASE_WITH_UNDERSCORES for "constants" et cetera.

It's a good idea to check your code with flake8 (https://pypi.python.org/pypi/flake8) or similar tools.

Version Control

Workflow

FST use Git for version control.

Ongoing work takes place on the develop branch and official releases are merged into the master branch. These branches are built nightly on Travis CI and should always pass automated tests. New features are worked on in feature branches. Such branches are shortlived and should either be merged into develop or abandoned.

This is the default setup used by Git Flow, which we use for development. Gitflow is not a requirement, it is just a tool to make our preferred kind of workflow easier.

Anyone with an active interest in FST can fork this project. Here is a Github guide describing how you can create a copy of a project and keep collaborating with the original.

Release Names (Tags)

Follow the Semantic Versioning conventions.

Settings for line-endings

See Github Help: Dealing with line endings.

This means that Windows users should have this configured:

$ git config --global core.autocrlf input