Skip to content

Commit 024138d

Browse files
authored
Merge pull request #329 from tensorlayer/lgarithm-patch-1
Create CONTRIBUTING.md
2 parents 83c79fb + 4975270 commit 024138d

File tree

2 files changed

+20
-1
lines changed

2 files changed

+20
-1
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Contributing to TensorLayer
2+
3+
We appreciate contributions towards TensorLayer
4+
either by adding / improving examples or extending / fixing the TensorLayer core library.
5+
To make your contributions, you would need to follow the guideline:
6+
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).
7+
The following tools are used to ensure that your PR comply the project convention:
8+
9+
* yapf (format code)
10+
* isort (sort imports)
11+
* autoflake (remove unused imports)
12+
13+
Please apply these tools in the changed files before submitting the PR.

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -231,7 +231,7 @@ We provide many helper functions (like `fit()` , `test()`) that is similar to Ke
231231
-->
232232

233233

234-
# Contributions
234+
# Community
235235

236236
TensorLayer is maintained by numerous Github contributors [here](https://github.com/zsdonghao/tensorlayer/graphs/contributors).
237237
This project is in an active development stage and has received numerous contributions from an open community.
@@ -246,6 +246,12 @@ TensorLayer started as an internal repository at Imperial College London, helpin
246246
- 🇬🇧 If you have question, drop us an email: [email protected].
247247
- 🇨🇳 我们有官方的[中文文档](http://tensorlayercn.readthedocs.io/zh/latest), 另外我们建立了多种交流渠道, 如[QQ群](img/img_qq.png)[微信群](https://github.com/shorxp/tensorlayer-chinese/blob/master/docs/wechat_group.md).
248248

249+
250+
# Contributions
251+
252+
[Contributing guideline](./CONTRIBUTING.md)
253+
254+
249255
# Citation
250256
If you find it is useful, please cite our paper in your project and paper.
251257

0 commit comments

Comments
 (0)