CONTRIBUTING.md

How to contribute to TrnPy

First time setup in your local environment

• Make sure you have a GitHub account.

• Download and install the latest version of git.

• Configure git with your username and email.

  $ git config --global user.name 'your name'
  $ git config --global user.email 'your email'

• Fork TrnPy to your GitHub account by clicking the Fork button.

• Clone your fork locally, replacing your-username in the command below with your actual username.

  $ git clone https://github.com/your-username/trnpy
  $ cd trnpy

• Create a virtualenv. Use the latest version of Python.

  • Linux/macOS

    $ python3 -m venv .venv --prompt trnpy
    $ source .venv/bin/activate

  • Windows

    > py -3 -m venv .venv --prompt trnpy
    > .venv\Scripts\activate

• Install TrnPy in editable mode with development dependencies.

  $ python -m pip install -U pip
  $ pip install -e ".[lint,test,typing]"