blob: 81a1874653ed55aea49193e674deb56ac78c703a [file] [log] [blame]
Ghanshyam Mann95c410a2020-04-19 17:44:59 -05001============================
2So You Want to Contribute...
3============================
4
5For general information on contributing to OpenStack, please check out the
6`contributor guide <https://docs.openstack.org/contributors/>`_ to get started.
7It covers all the basics that are common to all OpenStack projects: the accounts
8you need, the basics of interacting with our Gerrit review system, how we
9communicate as a community, etc.
10
11Below will cover the more project specific information you need to get started
12with Tempest.
13
14Communication
15~~~~~~~~~~~~~
Ghanshyam Mann3e127642021-05-31 15:04:48 -050016* IRC channel ``#openstack-qa`` at OFTC
Martin Kopecd76178e2024-01-16 20:43:56 +010017* `Mailing list <https://lists.openstack.org/mailman3/lists/openstack-discuss.lists.openstack.org/>`_
18 (prefix subjects with ``[qa]`` for faster responses)
19
Ghanshyam Mann95c410a2020-04-19 17:44:59 -050020
21Contacting the Core Team
22~~~~~~~~~~~~~~~~~~~~~~~~
Ghanshyam Mannd9654da2020-04-22 21:54:19 -050023Please refer to the `Tempest Core Team
Ghanshyam Mann95c410a2020-04-19 17:44:59 -050024<https://review.opendev.org/#/admin/groups/42,members>`_ contacts.
25
26New Feature Planning
27~~~~~~~~~~~~~~~~~~~~
28If you want to propose a new feature please read `Feature Proposal Process`_
29Tempest features are tracked on `Launchpad BP <https://blueprints.launchpad.net/tempest>`_.
Martin Kopecd76178e2024-01-16 20:43:56 +010030It also helps to bring the feature up during the next PTG and contact
31`the current PTL of QA project <https://governance.openstack.org/tc/reference/projects/>`_.
32Information about PTG is always posted on `the Mailing list
33<https://lists.openstack.org/mailman3/lists/openstack-discuss.lists.openstack.org/>`_.
Ghanshyam Mann95c410a2020-04-19 17:44:59 -050034
35Task Tracking
36~~~~~~~~~~~~~
37We track our tasks in `Launchpad <https://bugs.launchpad.net/tempest>`_.
38
Martin Kopecd76178e2024-01-16 20:43:56 +010039If you're looking for some smaller, easier work items to pick up and get started
Ghanshyam Mann95c410a2020-04-19 17:44:59 -050040on, search for the 'low-hanging-fruit' tag.
41
42Reporting a Bug
43~~~~~~~~~~~~~~~
Martin Kopecd76178e2024-01-16 20:43:56 +010044Have you found an issue and want to make sure we are aware of it? You can do so
45on `Launchpad <https://bugs.launchpad.net/tempest/+filebug>`__.
Ghanshyam Mann95c410a2020-04-19 17:44:59 -050046More info about Launchpad usage can be found on `OpenStack docs page
47<https://docs.openstack.org/contributors/common/task-tracking.html#launchpad>`_
48
49Getting Your Patch Merged
50~~~~~~~~~~~~~~~~~~~~~~~~~
Martin Kopecd76178e2024-01-16 20:43:56 +010051All changes proposed to the Tempest require a single ``Code-Review +2`` vote
52from a Tempest core followed by a ``Workflow +1`` vote. More detailed guidelines
Ghanshyam Mannbfce1f22021-02-03 16:50:34 -060053for reviewers are available at :doc:`../REVIEWING`.
Ghanshyam Mann95c410a2020-04-19 17:44:59 -050054
55Project Team Lead Duties
56~~~~~~~~~~~~~~~~~~~~~~~~
57All common PTL duties are enumerated in the `PTL guide
58<https://docs.openstack.org/project-team-guide/ptl.html>`_.
59
Ghanshyam Mannd9654da2020-04-22 21:54:19 -050060The Release Process for QA is documented in `QA Release Process
61<https://wiki.openstack.org/wiki/QA/releases>`_.
Ghanshyam Mann95c410a2020-04-19 17:44:59 -050062
63.. _Feature Proposal Process: https://wiki.openstack.org/wiki/QA#Feature_Proposal_.26_Design_discussions