Skip to content

Commit

Permalink
updating contributing doc
Browse files Browse the repository at this point in the history
  • Loading branch information
jinimukh committed Nov 29, 2020
1 parent 11dedf7 commit c32b57d
Showing 1 changed file with 14 additions and 5 deletions.
19 changes: 14 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,18 +35,27 @@ lux/
- lux/
```

# Code Formatting
In order to keep our codebase clean and readible, we are using PEP8 guidelines. To help us maintain and check code style, we are using [black](https://github.com/psf/black). Simply run `black .` before commiting. Failure to do so may fail the tests run on Travis. This package should have been installed for you.

# Running the Test Suite

There is a suite of test files for ensuring that Lux is working correctly. These tests are triggered to run via [Travis CI](https://travis-ci.com/lux-org/lux) whenever there is a commit made to the lux repository.
There is a suite of test files for ensuring that Lux is working correctly. These tests are triggered to run via [Travis CI](https://travis-ci.com/lux-org/lux) whenever there is a commit made to the lux repository. You can run them locally to make sure that your changes are working and do not break any of the existing tests.

You can run them locally to make sure that your changes are working and do not break any of the existing tests:
To run all the tests, including checking for code formatting, run:

```
python -m pytest tests/*.py
make
make test
```

# Code Formatting
In order to keep our codebase clean and readible, we are using PEP8 guidelines. To help us maintain and check code style, we are using [black](https://github.com/psf/black). Simply run `black --line-length 105 .` before commiting. Failure to do so may fail the tests run on Travis. This package should have been installed for you.
To run a single test file, run:

```
python -m pytest tests/<test_file_name>.py
```



# Submitting a Pull Request

Expand Down

0 comments on commit c32b57d

Please sign in to comment.