Skip to content

Update CONTRIBUTING.md #332

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Feb 19, 2018
Merged

Update CONTRIBUTING.md #332

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
52dab60
Update CONTRIBUTING.md
luomai Feb 19, 2018
585544c
Update CONTRIBUTING.md
luomai Feb 19, 2018
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: 9 additions & 9 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Contributing to TensorLayer

We appreciate contributions towards TensorLayer
either by adding / improving examples or extending / fixing the TensorLayer core library.
To make your contributions, you would need to follow the guideline:
we are using [pep8](https://www.python.org/dev/peps/pep-0008/) coding style and [numpy doc style](https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt).
The following tools are used to ensure that your PR comply the project convention:
We appreciate contributions
either by adding / improving examples or extending / fixing the core library.
To make your contributions, you would need to follow the [pep8](https://www.python.org/dev/peps/pep-0008/) coding style and [numpydoc](https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt) document style.
We rely on Continuous Integration (CI) for checking push commits.
The following tools are used to ensure that your commits can pass through the CI test:

* yapf (format code)
* isort (sort imports)
* autoflake (remove unused imports)
* [yapf](https://github.com/google/yapf) (format code), compulsory
* [isort](https://github.com/timothycrosley/isort) (sort imports), optional
* [autoflake](https://github.com/myint/autoflake) (remove unused imports), optional

Please apply these tools in the changed files before submitting the PR.
Please apply these tools in the changed files before submitting your PR.