diff options
| -rw-r--r-- | CONTRIBUTING.rst | 22 | ||||
| -rw-r--r-- | doc/source/contributor/contributing.rst | 59 | ||||
| -rw-r--r-- | doc/source/index.rst | 12 |
3 files changed, 82 insertions, 11 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index a89ad94f7..2300763ff 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,17 +1,19 @@ -If you would like to contribute to the development of OpenStack, you must -follow the steps in this page: +The source repository for this project can be found at: - https://docs.openstack.org/infra/manual/developers.html + https://opendev.org/openstack/tempest -If you already have a good understanding of how the system works and your -OpenStack accounts are set up, you can skip to the development workflow -section of this documentation to learn how changes to OpenStack should be -submitted for review via the Gerrit tool: +Pull requests submitted through GitHub are not monitored. - https://docs.openstack.org/infra/manual/developers.html#development-workflow +To start contributing to OpenStack, follow the steps in the contribution guide +to set up and use Gerrit: -Pull requests submitted through GitHub will be ignored. + https://docs.openstack.org/contributors/code-and-documentation/quick-start.html -Bugs should be filed on Launchpad, not GitHub: +Bugs should be filed on Launchpad: https://bugs.launchpad.net/tempest + +For more specific information about contributing to this repository, see the +Tempest contributor guide: + + https://docs.openstack.org/tempest/latest/contributor/contributing.html diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst new file mode 100644 index 000000000..38673a00e --- /dev/null +++ b/doc/source/contributor/contributing.rst @@ -0,0 +1,59 @@ +============================ +So You Want to Contribute... +============================ + +For general information on contributing to OpenStack, please check out the +`contributor guide <https://docs.openstack.org/contributors/>`_ to get started. +It covers all the basics that are common to all OpenStack projects: the accounts +you need, the basics of interacting with our Gerrit review system, how we +communicate as a community, etc. + +Below will cover the more project specific information you need to get started +with Tempest. + +Communication +~~~~~~~~~~~~~ +* IRC channel #openstack-qa at FreeNode +* Mailing list (prefix subjects with ``[qa]`` for faster responses) + http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss + +Contacting the Core Team +~~~~~~~~~~~~~~~~~~~~~~~~ +Please refer the `Tempest Core Team +<https://review.opendev.org/#/admin/groups/42,members>`_ contacts. + +New Feature Planning +~~~~~~~~~~~~~~~~~~~~ +If you want to propose a new feature please read `Feature Proposal Process`_ +Tempest features are tracked on `Launchpad BP <https://blueprints.launchpad.net/tempest>`_. + +Task Tracking +~~~~~~~~~~~~~ +We track our tasks in `Launchpad <https://bugs.launchpad.net/tempest>`_. + +If you're looking for some smaller, easier work item to pick up and get started +on, search for the 'low-hanging-fruit' tag. + +Reporting a Bug +~~~~~~~~~~~~~~~ +You found an issue and want to make sure we are aware of it? You can do so on +`Launchpad <https://bugs.launchpad.net/tempest/+filebug>`__. +More info about Launchpad usage can be found on `OpenStack docs page +<https://docs.openstack.org/contributors/common/task-tracking.html#launchpad>`_ + +Getting Your Patch Merged +~~~~~~~~~~~~~~~~~~~~~~~~~ +All changes proposed to the Tempest requires two ``Code-Review +2`` votes from +Tempest core reviewers before one of the core reviewers can approve patch by +giving ``Workflow +1`` vote. More detailed guidelines for reviewers are available +at :doc:`../REVIEWING`. + +Project Team Lead Duties +~~~~~~~~~~~~~~~~~~~~~~~~ +All common PTL duties are enumerated in the `PTL guide +<https://docs.openstack.org/project-team-guide/ptl.html>`_. + +Release Process fir QA is documented in `QA Release Process +<https://wiki.openstack.org/wiki/QA#Releases_Process>`_. + +.. _Feature Proposal Process: https://wiki.openstack.org/wiki/QA#Feature_Proposal_.26_Design_discussions diff --git a/doc/source/index.rst b/doc/source/index.rst index ab994d12b..630cccce1 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -56,6 +56,16 @@ Supported OpenStack Releases and Python Versions supported_version +For Contributors +================ + +* If you are a new contributor to Tempest please refer: :doc:`contributor/contributing` + +.. toctree:: + :hidden: + + contributor/contributing + Developers Guide ================ @@ -104,4 +114,4 @@ Search * :ref:`Tempest document search <search>`: Search the contents of this document. * `OpenStack wide search <https://docs.openstack.org>`_: Search the wider - set of OpenStack documentation, including forums.
\ No newline at end of file + set of OpenStack documentation, including forums. |