added documentationo on the new pytest-dev teams on bitbucket and

github.  See https://pytest.org/latest/contributing.html (tentative)
Thanks to Anatoly for pushing and initial work on this.

--HG--
branch : docs_community
This commit is contained in:
holger krekel
2015-02-27 11:54:17 +01:00
parent e9d4853296
commit f6df3b0b97
3 changed files with 65 additions and 44 deletions

View File

@@ -1,18 +1,59 @@
============
Contributing
============
============================
Contribution getting started
============================
Contributions are highly welcomed and appreciated. Every little help counts,
so do not hesitate!
.. contents:: Contribution links
:depth: 2
Types of contributions
======================
.. _submitplugin:
Submit a plugin, co-develop pytest
----------------------------------
Pytest development of the core, some plugins and support code happens
in repositories living under:
- `the pytest-dev bitbucket team <https://bitbucket.org/pytest-dev>`_
- `the pytest-dev github organisation <https://github.com/pytest-dev>`_
All pytest-dev team members have write access to all contained
repositories. pytest core and plugins are generally developed
using `pull requests`_ to respective repositories.
You can submit your plugin by subscribing to the `pytest-dev mail list
<https://mail.python.org/mailman/listinfo/pytest-dev>`_ and writing a
mail pointing to your existing pytest plugin repository which must have
the following:
- PyPI presence with a ``setup.py`` that contains a license, ``pytest-``
prefixed, version number, authors, short and long description.
- a ``tox.ini`` for running tests using `tox <http://tox.testrun.org>`_.
- a ``README.txt`` describing how to use the plugin and on which
platforms it runs.
- an issue tracker unless you rather want to use the core ``pytest``
issue tracker.
If no contributor strongly objects and two agree, the repo will be
transferred to the ``pytest-dev`` organisation and you'll become a
member of the ``pytest-dev`` team, with commit rights to all projects.
We recommend that each plugin has at least three people who have the
right to release to pypi.
.. _reportbugs:
Report bugs
-----------
Report bugs at https://bitbucket.org/hpk42/pytest/issues.
Report bugs for pytest at https://bitbucket.org/hpk42/pytest/issues
If you are reporting a bug, please include:
@@ -22,6 +63,8 @@ If you are reporting a bug, please include:
installed libraries and pytest version.
* Detailed steps to reproduce the bug.
.. _submitfeedback:
Submit feedback for developers
------------------------------
@@ -37,6 +80,7 @@ We'd also like to hear about your propositions and suggestions. Feel free to
* If you have required skills and/or knowledge, we are very happy for
:ref:`pull requests <pull-requests>`.
.. _fixbugs:
Fix bugs
--------
@@ -46,6 +90,8 @@ https://bitbucket.org/hpk42/pytest/issues?status=new&status=open&kind=bug
:ref:`Talk <contact>` to developers to find out how you can fix specific bugs.
.. _writeplugins:
Implement features
------------------
@@ -67,6 +113,7 @@ pytest could always use more documentation. What exactly is needed?
* Blog posts, articles and such -- they're all very appreciated.
.. _pull-requests:
.. _`pull requests`:
Preparing Pull Requests on Bitbucket
=====================================
@@ -154,7 +201,7 @@ the issues there and submit your pull requests.
.. _contribution-using-git:
What about git (and so GitHub)?
Using git with bitbucket/hg
-------------------------------
There used to be the pytest GitHub mirror. It was removed in favor of the