diff options
author | Dylan Baker <dylan@pnwbakers.com> | 2017-08-18 10:55:19 -0700 |
---|---|---|
committer | Dylan Baker <dylan@pnwbakers.com> | 2017-08-18 15:44:42 -0700 |
commit | be6cbfc8603bd9eda1bd160ed5aa507c9ede81a5 (patch) | |
tree | e27b408d9b7bd9922670f91253839e6233d0e576 /docs | |
parent | 26075d8710cc4f460cb8645352ca63cf4398568c (diff) |
docs: Use CONTRIBUTING.rst as contributing.rst
Diffstat (limited to 'docs')
l---------[-rw-r--r--] | docs/source/api/contributing.rst | 24 |
1 files changed, 1 insertions, 23 deletions
diff --git a/docs/source/api/contributing.rst b/docs/source/api/contributing.rst index a288a7f8..c3474c07 100644..120000 --- a/docs/source/api/contributing.rst +++ b/docs/source/api/contributing.rst @@ -1,23 +1 @@ -Contributing -============ - -Development is coordinated entirely via the projects `github page <https://github.com/pazz/alot>`_ -especially the `issue tracker <https://github.com/pazz/alot/issues>`_. - -You can send patches to notmuch's mailing list but pull requests on github are preferred. -Here are a few more things you should know and check before you send pull requests: - -* Follow :pep:`8`. This means in particular a maximum linewidth of *79* and no trailing - white spaces. If in doubt, use an Automatic tool - (`[0] <http://www.logilab.org/857>`_, `[1] <http://pypi.python.org/pypi/pep8/>`_, `[2] - <http://pypi.python.org/pypi/pyflakes/>`_) - to verify your code. - -* Document! Needless to say, we want readable and well documented code. Moreover, - - * use `sphinx directives <http://sphinx.pocoo.org/domains.html#info-field-lists>`_ to document - the parameters and return values of your methods so that we maintain up-to-date API docs. - * Make sure your patch doesn't break the API docs. The build service at `readthedocs.org <http://alot.rtfd.org>`_ - is fragile when it comes to new import statements in our code. - * If you implemented a new feature, update the user manual in :file:`/docs/user` accordingly. - +../../../.github/CONTRIBUTING.rst
\ No newline at end of file |