Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Makefile and pyproject.toml #160

Merged
merged 33 commits into from
Nov 29, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
b2ffe14
add black to travis
jinimukh Oct 27, 2020
6715ebe
reformat all code and adjust test
jinimukh Oct 27, 2020
6aa02f4
remove .idea
jinimukh Oct 29, 2020
d3b0320
fix contributing doc
jinimukh Oct 29, 2020
352ba04
update docs
jinimukh Oct 29, 2020
60b8eff
small change in contributing
jinimukh Oct 29, 2020
4cfb30c
merge master
jinimukh Oct 29, 2020
824dd18
update
jinimukh Oct 29, 2020
ce0cd33
merge master
jinimukh Nov 2, 2020
4aa4bd4
reformat, update command to fix version
jinimukh Nov 2, 2020
4b51dd4
remove dev dependencies
jinimukh Nov 2, 2020
11b19dc
merge master
jinimukh Nov 2, 2020
719cc67
merge master
jinimukh Nov 11, 2020
700a0bc
first pass -- inline comments
jinimukh Nov 11, 2020
c8f2db5
_config/config.py
jinimukh Nov 14, 2020
4a361e1
delete test notebook
jinimukh Nov 14, 2020
3aceabc
action
jinimukh Nov 14, 2020
1e7e03b
line length 105
jinimukh Nov 14, 2020
74e8207
merge master
jinimukh Nov 14, 2020
d43dab9
executor
jinimukh Nov 14, 2020
104c365
interestingness
jinimukh Nov 14, 2020
41306c3
processor
jinimukh Nov 14, 2020
a466a08
vislib
jinimukh Nov 14, 2020
a702ab1
tests, travis, CONTRIBUTING
jinimukh Nov 16, 2020
eccb8e4
.format
jinimukh Nov 16, 2020
1596343
replace tabs with escape chars
jinimukh Nov 16, 2020
fb1cfad
Merge branch 'master' of https://github.com/lux-org/lux into issues/f…
jinimukh Nov 16, 2020
8c3b2c1
update using black
jinimukh Nov 16, 2020
b468b07
more rewrites and merges into single line
dorisjlee Nov 16, 2020
a412ab4
merge master
jinimukh Nov 28, 2020
11dedf7
update pyproject.toml and makefile
jinimukh Nov 28, 2020
c32b57d
updating contributing doc
jinimukh Nov 29, 2020
cdbfde1
Update CONTRIBUTING.md
dorisjlee Nov 29, 2020
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,18 +35,26 @@ 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 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
1 change: 1 addition & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
init:
pip install -r requirements.txt
test:
black --check .
python -m pytest tests/
.PHONY: init test
2 changes: 2 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[tool.black]
line-length = 105