diff options
| author | Ian Lee <IanLee1521@gmail.com> | 2015-11-08 17:06:02 -0800 |
|---|---|---|
| committer | Ian Lee <IanLee1521@gmail.com> | 2015-11-08 17:06:02 -0800 |
| commit | 4dc42d842274ba27d2724e76eb83ff69e7db226f (patch) | |
| tree | de4faf5bf54f9deecb1375d2ecf2d8356e61c837 | |
| parent | e73d8fbe4151345ab78b69300cdeea5d9b67840b (diff) | |
| parent | 86284a8d839c854cd787fdcd66bcc0ee1fe15bc8 (diff) | |
| download | pep8-4dc42d842274ba27d2724e76eb83ff69e7db226f.tar.gz | |
Merge pull request #460 from doismellburning/feature/contrib-high-level
Documentation of high-level goals/aims/decisions
| -rw-r--r-- | CONTRIBUTING.rst | 4 | ||||
| -rw-r--r-- | docs/developer.rst | 15 |
2 files changed, 19 insertions, 0 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 0000000..158dc6f --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,4 @@ +Contributing to ``pep8`` +======================== + +Please see the `developer notes <https://pep8.readthedocs.org/en/latest/developer.html>`_ diff --git a/docs/developer.rst b/docs/developer.rst index 9db13b1..4ffc132 100644 --- a/docs/developer.rst +++ b/docs/developer.rst @@ -20,6 +20,21 @@ conditions of the :ref:`Expat license <license>`. Fork away! .. _available on GitHub: https://github.com/pycqa/pep8 +Direction +~~~~~~~~~ + +Some high-level aims and directions to bear in mind for contributions: + +* ``pep8`` is intended to be as fast as possible. + Using the ``ast`` module defeats that purpose. + The `pep8-naming <https://github.com/flintwork/pep8-naming>`_ plugin exists for this sort of functionality. +* If you want to provide extensibility / plugins, + please see `flake8 <https://gitlab.com/pycqa/flake8>`_ - + ``pep8`` doesn't want or need a plugin architecture. +* Python 2.6 support is still deemed important. +* ``pep8`` aims to have no external dependencies. + + Contribute ~~~~~~~~~~ |