diff options
| -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 ~~~~~~~~~~ |