Skip to content

Commit

Permalink
updated contribution docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jtisbell4 committed Apr 28, 2024
1 parent 550d4e0 commit 333975a
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,18 @@ Be sure to carefully follow the instructions to configure your shell environment

Use `pyenv` to install the following Python versions for testing.
```bash
pyenv install 3.7 3.8 3.9
pyenv install 3.8 3.9 3.10
```

You will probably want to set one of these versions as your global Python version. This will be the version of Python that is used when you run `python` commands in your terminal.
For example, to set Python 3.9 as your global Python version, run the following command:
```bash
pyenv global 3.9
pyenv global 3.10
```

Within the `tempo/python` folder, run the below command to create a `.python-version` file that will tell `pyenv` which Python version to use when running commands in this directory:
```bash
pyenv local 3.7 3.8 3.9
pyenv local 3.8 3.9 3.10
```

This allows `tox` to create virtual environments using any of the Python versions listed in the `.python-version` file.
Expand Down Expand Up @@ -64,9 +64,10 @@ This will run tests for all listed environments.
### Run additional checks locally
`tox` has special environments for additional checks that must be performed as part of the PR process. These include formatting, linting, type checking, etc.
These environments are also defined in the `tox.ini`file and skip installing dependencies listed in the `requirements.txt` file and building the distribution when those are not required . They can be specified using the `-e` flag:
* format
* lint
* type-check
* build-dist
* build-docs
* coverage-report

# Code style & Standards
Expand Down

0 comments on commit 333975a

Please sign in to comment.