Skip to content

Latest commit

 

History

History
77 lines (50 loc) · 1.76 KB

CONTRIBUTING.md

File metadata and controls

77 lines (50 loc) · 1.76 KB
Raw

Contributing guidelines

Contents

  1. Reporting issues
  2. Contributing a patch
  3. Setup for development
  4. Testing
  5. Coding conventions

Reporting issues

Open an issue and fill each field of the issue template, unless you have a reason to not fill some field.

Contributing a patch

  1. Submit an issue describing your proposed change to the repo in question.
  2. Some repo maintainer will respond to your issue promptly.
  3. Fork the repo and set your environment up for development.
  4. Develop your changes following our coding conventions, add tests to your change and run them locally.
  5. Submit a pull request.

Setup for development

Install virtualenvwrapper.

pip install virtualenv virtualenvwrapper

After installing virtualenvwrapper please add the following line to your shell startup file (e.g. ~/.zshrc, again if you haven't):

source /usr/local/bin/virtualenvwrapper.sh

Reset your terminal.

Clone this respository, create the virtual environment, install some dependencies and run:

$ GIHUB_USERNAME="your_username"
$ git clone https://github.com/$GITHUB_USERNAME/travieso
$ cd travieso
$ mkvirtualenv travieso
$ workon travieso
$ pip install -r requirements.txt
$ gem install foreman
$ foreman start

Testing

To run the tests, you just do:

$ pip install tox
$ tox

Coding conventions

We use editorconfig to define our coding style. Please add editorconfig to your editor of choice.

When running tox linting will also be run along with the tests. You can also run linting only by doing:

$ tox -e flake8