source: trunk/CONTRIBUTORS.rst

Last change on this file was 9c7f9432, checked in by May-Lee Sia <mayleesia@…>, at 2021-05-07T14:10:24Z

Add suggestion for Tahoe Committers

  • Property mode set to 100644
File size: 1.6 KB
Line 
1Contributor Checklist
2=====================
3
4
5* Create a ``Trac`` ticket, fill it out and assign it to yourself (contact exarkun if you don't have an account):
6
7  ``https://tahoe-lafs.org/trac/tahoe-lafs/newticket``
8
9* Use the ticket number to name your branch (example):
10
11  ``3003.contributor-guide``
12
13* Good idea to add tests at the same time you write your code.
14
15* Add a file to the ``/newsfragments`` folder, named with the ticket number and the type of patch (example):
16
17  ``newsfragments/3651.minor``
18
19* ``towncrier`` recognizes the following types:
20
21  ``incompat``, ``feature``, ``bugfix``, ``installation``, ``configuration``, ``documentation``, ``removed``, ``other``, ``minor``
22* Add one sentence to ``newsfragments/<ticket-number>.<towncrier-type>`` describing the change (example):
23
24  ``The integration test suite has been updated to use pytest-twisted instead of deprecated pytest APIs.``
25
26* Run the test suite with ``tox``, ``tox -e codechecks`` and ``tox -e typechecks``
27
28* Push your branch to Github with your ticket number in the merge commit message (example):
29
30  ``Fixes ticket:3003``
31
32  This makes the ``Trac`` ticket close when your PR gets approved.
33
34* Request appropriate review - we suggest asking `Tahoe Committers <https://github.com/orgs/tahoe-lafs/teams/tahoe-committers>`__
35
36References
37----------
38
39This checklist is a summary of `this page on contributing Patches <https://tahoe-lafs.org/trac/tahoe-lafs/wiki/Patches>`__ 
40
41Before authoring or reviewing a patch, please familiarize yourself with the `Coding Standard <https://tahoe-lafs.org/trac/tahoe-lafs/wiki/CodingStandards>`__ 
42and the `Contributor Code of Conduct <docs/CODE_OF_CONDUCT.md>`__.
Note: See TracBrowser for help on using the repository browser.