[ussuri][goal] Update contributor documentation
This patch updates/adds the contributor documentation to follow the guidelines of the Ussuri cycle community goal[1]. [1] https://governance.openstack.org/tc/goals/selected/ussuri/project-ptl-and-contrib-docs.html Story: #2007236 Task: #38554 Change-Id: Ief0ff4a7f69a4ba44abd846d720630c2232d4fe0
This commit is contained in:
parent
349e45cb41
commit
060abe4f82
@ -1,13 +1,19 @@
|
|||||||
If you would like to contribute to the development of OpenStack,
|
The source repository for this project can be found at:
|
||||||
you must follow the steps in this page:
|
|
||||||
http://docs.openstack.org/infra/manual/developers.html
|
|
||||||
|
|
||||||
Once those steps have been completed, changes to OpenStack
|
https://opendev.org/openstack/bashate
|
||||||
should be submitted for review via the Gerrit tool, following
|
|
||||||
the workflow documented at:
|
|
||||||
http://docs.openstack.org/infra/manual/developers.html#development-workflow
|
|
||||||
|
|
||||||
Pull requests submitted through GitHub will be ignored.
|
Pull requests submitted through GitHub are not monitored.
|
||||||
|
|
||||||
Bugs should be filed on Launchpad, not GitHub:
|
To start contributing to OpenStack, follow the steps in the contribution guide
|
||||||
https://bugs.launchpad.net/bash8
|
to set up and use Gerrit:
|
||||||
|
|
||||||
|
https://docs.openstack.org/contributors/code-and-documentation/quick-start.html
|
||||||
|
|
||||||
|
Bugs should be filed on Launchpad:
|
||||||
|
|
||||||
|
https://bugs.launchpad.net/bash8
|
||||||
|
|
||||||
|
For more specific information about contributing to this repository, see the
|
||||||
|
Bashate contributor guide:
|
||||||
|
|
||||||
|
https://docs.openstack.org/bashate/latest/contributor/contributing.html
|
||||||
|
53
doc/source/contributor/contributing.rst
Normal file
53
doc/source/contributor/contributing.rst
Normal file
@ -0,0 +1,53 @@
|
|||||||
|
============================
|
||||||
|
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 Bashate.
|
||||||
|
|
||||||
|
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 to the `Bashate Core Team
|
||||||
|
<https://review.opendev.org/#/admin/groups/333,members>`_ contacts.
|
||||||
|
|
||||||
|
New Feature Planning
|
||||||
|
~~~~~~~~~~~~~~~~~~~~
|
||||||
|
If you want to propose a new feature please read `Feature Proposal Process`_
|
||||||
|
|
||||||
|
Task Tracking
|
||||||
|
~~~~~~~~~~~~~
|
||||||
|
We track our tasks in `Launchpad <https://bugs.launchpad.net/bash8>`__.
|
||||||
|
|
||||||
|
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/bash8/+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 Bashate requires single ``Code-Review +2`` votes as minimum from
|
||||||
|
Bashate core reviewers who can approve patch by giving ``Workflow +1`` vote.
|
||||||
|
|
||||||
|
Project Team Lead Duties
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
All common PTL duties are enumerated in the `PTL guide
|
||||||
|
<https://docs.openstack.org/project-team-guide/ptl.html>`_.
|
||||||
|
|
||||||
|
The Release Process for QA is documented in `QA Release Process
|
||||||
|
<https://wiki.openstack.org/wiki/QA/releases>`_.
|
||||||
|
|
||||||
|
.. _Feature Proposal Process: https://wiki.openstack.org/wiki/QA#Feature_Proposal_.26_Design_discussions
|
@ -1,4 +1,4 @@
|
|||||||
============
|
============
|
||||||
Contributing
|
Contributing
|
||||||
============
|
============
|
||||||
.. include:: ../../../CONTRIBUTING.rst
|
.. include:: ./contributing.rst
|
||||||
|
Loading…
Reference in New Issue
Block a user