Contributing [common]

Git branches

What follows is a table of the git branches used in the repositories following fpydocs’ specifications.

Important

Open pull requests on the dev target branch. Use bugfix-${fix_name} or newfeature-${new_feature_name} as names.

Branch	Description	Update schedule
`master`	the main branch	every new release
`dev`	recent changes are merged here before a new release	at will
`bugfix-${fix_name}`	a generic bug fix
`newfeature-${new_feature_name}`	a generic new feature

install Pipenv
run the following to install the development environment
```
make install-dev
```
you can use pipenv run to run the program in the development environment
if you have changed parts of the source code you must take care of adding the corresponding unit tests if applicable.
run the tests with:
```
make test
```
to install the program for the running user run:
```
make install
```
Note

don’t forget to add ~/.local/bin to PATH.
to rebuild the documentation run
```
make doc
```

Go in the repository’s root and then:

$ grep -e TODO -e FIXME -n */*.py