|
2 | 2 | Development Guide
|
3 | 3 | =================
|
4 | 4 |
|
5 |
| -Some general guidelines regarding development in pytest for maintainers and contributors. Nothing here |
6 |
| -is set in stone and can't be changed, feel free to suggest improvements or changes in the workflow. |
7 |
| - |
8 |
| - |
9 |
| -Code Style |
10 |
| ----------- |
11 |
| - |
12 |
| -* `PEP-8 <https://www.python.org/dev/peps/pep-0008>`_ |
13 |
| -* `flake8 <https://pypi.org/project/flake8/>`_ for quality checks |
14 |
| -* `invoke <http://www.pyinvoke.org/>`_ to automate development tasks |
15 |
| - |
16 |
| - |
17 |
| -Branches |
18 |
| --------- |
19 |
| - |
20 |
| -We have two long term branches: |
21 |
| - |
22 |
| -* ``master``: contains the code for the next bug-fix release. |
23 |
| -* ``features``: contains the code with new features for the next minor release. |
24 |
| - |
25 |
| -The official repository usually does not contain topic branches, developers and contributors should create topic |
26 |
| -branches in their own forks. |
27 |
| - |
28 |
| -Exceptions can be made for cases where more than one contributor is working on the same |
29 |
| -topic or where it makes sense to use some automatic capability of the main repository, such as automatic docs from |
30 |
| -`readthedocs <readthedocs.org>`_ for a branch dealing with documentation refactoring. |
31 |
| - |
32 |
| -Issues |
33 |
| ------- |
34 |
| - |
35 |
| -Any question, feature, bug or proposal is welcome as an issue. Users are encouraged to use them whenever they need. |
36 |
| - |
37 |
| -GitHub issues should use labels to categorize them. Labels should be created sporadically, to fill a niche; we should |
38 |
| -avoid creating labels just for the sake of creating them. |
39 |
| - |
40 |
| -Each label should include a description in the GitHub's interface stating its purpose. |
41 |
| - |
42 |
| -Labels are managed using `labels <https://github.com/hackebrot/labels>`_. All the labels in the repository |
43 |
| -are kept in ``.github/labels.toml``, so any changes should be via PRs to that file. |
44 |
| -After a PR is accepted and merged, one of the maintainers must manually synchronize the labels file with the |
45 |
| -GitHub repository. |
46 |
| - |
47 |
| -Temporary labels |
48 |
| -~~~~~~~~~~~~~~~~ |
49 |
| - |
50 |
| -To classify issues for a special event it is encouraged to create a temporary label. This helps those involved to find |
51 |
| -the relevant issues to work on. Examples of that are sprints in Python events or global hacking events. |
52 |
| - |
53 |
| -* ``temporary: EP2017 sprint``: candidate issues or PRs tackled during the EuroPython 2017 |
54 |
| - |
55 |
| -Issues created at those events should have other relevant labels added as well. |
56 |
| - |
57 |
| -Those labels should be removed after they are no longer relevant. |
58 |
| - |
59 |
| - |
60 |
| -.. include:: ../../RELEASING.rst |
| 5 | +The contributing guidelines are to be found :ref:`here <contributing>`. |
| 6 | +The release procedure for pytest is documented on |
| 7 | +`GitHub <https://github.com/pytest-dev/pytest/blob/master/RELEASING.rst>`_. |
0 commit comments