openstack
/
cyborg-tempest-plugin
Code Issues Proposed changes

[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: #38519
Change-Id: I3956461398da57b8b8622cbb5a584b777c80518e
This commit is contained in:
Ghanshyam Mann 2021-05-13 17:40:06 -05:00 committed by Ghanshyam
parent ff3204bdc9
commit 976b258f4b
2 changed files with 61 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
CONTRIBUTING.rst
View File

@ -1,15 +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://opendev.org/openstack/cyborg-tempest-plugin
http://docs.openstack.org/infra/manual/developers.html
Pull requests submitted through GitHub are not monitored.
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:
To start contributing to OpenStack, follow the steps in the contribution guide
to set up and use Gerrit:
http://docs.openstack.org/infra/manual/developers.html#development-workflow
https://docs.openstack.org/contributors/code-and-documentation/quick-start.html
Pull requests submitted through GitHub will be ignored.
Bugs should be filed on Launchpad:
Bugs should be filed on Storyboardhttps://storyboard.openstack.org/#!/project/968
https://bugs.launchpad.net/openstack-cyborg
For more specific information about contributing to this repository, see the
cyborg-tempest-plugin contributor guide:
https://opendev.org/openstack/cyborg-tempest-plugin/src/branch/master/doc/source/contributor/contributing.rst

47
doc/source/contributor/contributing.rst Normal file
View File

@ -0,0 +1,47 @@
============================
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 cyborg-tempest-plugin.
Communication
~~~~~~~~~~~~~
* IRC channel #openstack-cyborg at OFTC
* Mailing list (prefix subjects with ``[cyborg]`` for faster responses)
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss
Contacting the Core Team
~~~~~~~~~~~~~~~~~~~~~~~~
Please refer the `cyborg-tempest-plugin Core Team
<https://review.opendev.org/admin/groups/5ecdd69a9647b2854f0effd73b98580164ab7bc9>`_ contacts.
New Feature Planning
~~~~~~~~~~~~~~~~~~~~
cyborg-tempest-plugin features are tracked on `Launchpad Bugs <https://bugs.launchpad.net/openstack-cyborg>`_.
Task Tracking
~~~~~~~~~~~~~
We track our tasks in `Launchpad Bugs <https://bugs.launchpad.net/openstack-cyborg>`_.
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 Bugs <https://bugs.launchpad.net/openstack-cyborg>`_.
Getting Your Patch Merged
~~~~~~~~~~~~~~~~~~~~~~~~~
All changes proposed to the cyborg-tempest-plugin project require one or two +2 votes
from cyborg-tempest-plugin core reviewers before one of the core reviewers 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>`_.