CONTRIBUTING.md

Contributing

To contribute to VelocityConversion, feel free to open an issue anytime. Of course, you are also welcome to open pull requests from your personal forks.

Getting started

First, create your own personal fork of the repository using the fork button in the upper right corner of this page. If you have already cloned the repository from the original repository, continue at Use an existing clone. If you have not cloned it yet, continue with the next section.

Starting from scratch

Now, clone the fork to your personal hard drive:

# Note, that the URL will differ for your repository
git clone [email protected]:cmeessen/VelocityConversion.git

or via HTTPS:

git clone https://github.com/cmeessen/VelocityConversion.git

and cd into the corresponding folder on your disk

cd VelocityConversion

Use an existing clone

If you already cloned the repository, update the git remotes such that [email protected]:cmeessen/VelocityConversion.git will be named upstream:

# Rename current origin to upstream
git remote rename origin upstream
# Add your own fork
git remote add origin [email protected]:YOURUSERNAME/VelocityConversion.git

Create a virtual environment

Use pipenv to create a new virtual environment

pipenv shell

and install the dev-dependencies:

pipenv shell
pipenv install --dev

Code style

The python code in this repository is checked with pycodestyle. Please The rules for pycodestyle are defined in setup.cfg. Before creating a pull request, please check your code by running:

pycodestyle

If the command does not generate any output, the style is correct.

Building documentation

To build the documentation, go to the docs/sphinx folder,

cd docs/sphinx

and run

make html