diff options
author | Hynek Schlawack <hs@ox.cx> | 2015-09-06 09:00:15 +0200 |
---|---|---|
committer | Hynek Schlawack <hs@ox.cx> | 2015-09-06 09:00:15 +0200 |
commit | 35147f0a056b96c23f4b9fecda90d65564672630 (patch) | |
tree | e9c45147ca91977952ad18d684d189bd10235e8f /CONTRIBUTING.rst | |
parent | d58db90d1f27dcde91d39e32721e89f3524797a6 (diff) | |
download | pyopenssl-35147f0a056b96c23f4b9fecda90d65564672630.tar.gz |
Update CONTRIBUTING.rst
Diffstat (limited to 'CONTRIBUTING.rst')
-rw-r--r-- | CONTRIBUTING.rst | 21 |
1 files changed, 12 insertions, 9 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index d47c825..9588fba 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -9,7 +9,7 @@ Filing bug reports ------------------ Bug reports are very welcome. -Please file them on the GitHub issue tracker. +Please file them on the `GitHub issue tracker`_. Good bug reports come with extensive descriptions of the error and how to reproduce it. Reporters are strongly encouraged to include an `short, self contained, correct example <http://www.sscce.org/>`_. @@ -29,14 +29,15 @@ Patches All patches to pyOpenSSL should be submitted in the form of pull requests to the main pyOpenSSL repository, `pyca/pyopenssl`_. These pull requests should satisfy the following properties: -- The branch referenced should be a `feature branch`_ focusing on one particular improvement to pyOpenSSL. - Create different branches and different pull requests for unrelated features or bugfixes. +- The pull request should focus on one particular improvement to pyOpenSSL. + Create different pull requests for unrelated features or bugfixes. - Code should follow `PEP 8`_, especially in the "do what code around you does" sense. - One notable way pyOpenSSL code differs, for example, is that there should be three empty lines between module-level elements,and two empty lines between class-level elements. - Methods and functions are named in ``snake_case``. Follow OpenSSL naming for callables whenever possible is preferred. +- New tests should use `py.test-style assertions`_ instead of the old `self.assertXYZ`-style. - Pull requests that introduce code must test all new behavior they introduce as well as for previously untested or poorly tested behavior that they touch. - Pull requests are not allowed to break existing tests. + We usually don't comment on pull requests that are breaking the CI because we consider them work in progress. + Please note that not having 100% code coverage for the code you wrote/touched also causes our CI to fail. - Pull requests that introduce features or fix bugs should note those changes in the ``ChangeLog`` text file in the root of the repository. They should also document the changes, both in docstrings and in the documentation in the ``doc/`` directory. @@ -44,7 +45,7 @@ Finally, pull requests must be reviewed before merging. This process mirrors the `cryptography code review process`_. Everyone can perform reviews; this is a very valuable way to contribute, and is highly encouraged. -Pull requests are merged by members of PyCA. +Pull requests are merged by members of PyCA_. They should, of course, keep all the requirements detailed in this document as well as the ``pyca/cryptography`` merge requirements in mind. The final responsibility for the reviewing of merged code lies with the person merging it. @@ -60,12 +61,14 @@ You can also ask questions on our `mailing list`_. Wherever we interact, we strive to follow the `Python Community Code of Conduct`_. +.. _GitHub issue tracker: https://github.com/pyca/pyopenssl/issues .. _GPG: http://en.wikipedia.org/wiki/GNU_Privacy_Guard .. _Keybase: https://keybase.io/hynek .. _pyca/pyopenssl: https://github.com/pyca/pyopenssl .. _PEP 8: https://www.python.org/dev/peps/pep-0008/ +.. _py.test-style assertions: https://pytest.org/latest/assert.html .. _cryptography code review process: https://cryptography.io/en/latest/development/reviewing-patches/ -.. _feature branch: https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow .. _freenode: https://freenode.net -.. _`mailing list`: https://mail.python.org/mailman/listinfo/cryptography-dev -.. _`Python Community Code of Conduct`: https://www.python.org/psf/codeofconduct/ +.. _mailing list: https://mail.python.org/mailman/listinfo/cryptography-dev +.. _Python Community Code of Conduct: https://www.python.org/psf/codeofconduct/ +.. _PyCA: https://github.com/orgs/pyca/people |