提交 dc50fa74 authored 作者: Frederic's avatar Frederic

Added doc to tell people they should use git hooks.

上级 57361b11
...@@ -102,6 +102,28 @@ typo) to keep the history clean, you can do it like this: ...@@ -102,6 +102,28 @@ typo) to keep the history clean, you can do it like this:
git commit --amend git commit --amend
git push -u origin my_shiny_feature:my_shiny_feature git push -u origin my_shiny_feature:my_shiny_feature
Coding Style Auto Check
-----------------------
In Theano, we use the same coding style as the `Pylearn
<http://deeplearning.net/software/pylearn/v2_planning/API_coding_style.html>`_
project. The principal thing to know is that we follow the
`pep8 <http://www.python.org/dev/peps/pep-0008/>`_ coding style.
We use git hook provided in the project `pygithooks
<https://github.com/lumberlabs/pygithooks>`_ to validate that commit
respect pep8. This happen when each user commit, not when we
push/merge to the Theano repository. Github don't allow us to have
code executed when we push to the repository. So we ask all
contributor to use those hooks.
For historic reason, we currently don't have all file respecting pep8.
We decided fix everything incrementally. So not all file respect it
now. So we strongly suggest that you use the "increment" pygithooks
config option to have a good workflow. See the pygithooks main page
for how to set it up for Theano and how to enable this option.
Cleaning up history Cleaning up history
------------------- -------------------
......
Markdown 格式
0%
您添加了 0 到此讨论。请谨慎行事。
请先完成此评论的编辑!
注册 或者 后发表评论