openstack/heat-tempest-plugin
Code Issues Proposed changes

[ussuri][goal] Update contributor documentation

Browse Source 
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: #38524
Change-Id: I778f87085370bd82684f418f259f877743c5085c
This commit is contained in:
Ghanshyam Mann 2021-05-14 12:14:35 -05:00 committed by Rico Lin
parent 00a904e14e
commit 5c548478b5
2 changed files with 67 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
CONTRIBUTING.rst Normal file
View File

@ -0,0 +1,19 @@
The source repository for this project can be found at:
https://opendev.org/openstack/heat-tempest-plugin
Pull requests submitted through GitHub are not monitored.
To start contributing to OpenStack, follow the steps in the contribution guide
to set up and use Gerrit:
https://docs.openstack.org/contributors/code-and-documentation/quick-start.html
Bugs should be filed on Storyboard:
https://storyboard.openstack.org/#!/project/openstack/heat-tempest-plugin
For more specific information about contributing to this repository, see the
heat-tempest-plugin contributor guide:
https://opendev.org/openstack/heat-tempest-plugin/src/branch/master/doc/source/contributor/contributing.rst

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

@ -0,0 +1,48 @@
============================
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 heat-tempest-plugin.
Communication
~~~~~~~~~~~~~
* IRC channel #heat at OFTC
* Mailing list (prefix subjects with ``[heat]`` for faster responses)
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss
Contacting the Core Team
~~~~~~~~~~~~~~~~~~~~~~~~
Please refer the `heat-tempest-plugin Core Team
<https://review.opendev.org/admin/groups/b4b16f97f2b8416cb0111c0bec5df885bd779347,members>`_ contacts.
New Feature Planning
~~~~~~~~~~~~~~~~~~~~
heat-tempest-plugin features are tracked on `Storyboard <https://storyboard.openstack.org/#!/project/openstack/heat>`_.
Please specify the reported story with `heat-tempest-plugin`.
Task Tracking
~~~~~~~~~~~~~
We track our tasks in `Storyboard <https://storyboard.openstack.org/#!/project/openstack/heat>`_.
Please specify the reported story with `heat-tempest-plugin`.
Reporting a Bug
~~~~~~~~~~~~~~~
You found an issue and want to make sure we are aware of it? You can do so on
`StoryBoard <https://storyboard.openstack.org/#!/project/openstack/heat>`_.
Please specify the reported story with `heat-tempest-plugin`.
Getting Your Patch Merged
~~~~~~~~~~~~~~~~~~~~~~~~~
All changes proposed to the heat-tempest-plugin project require one or two +2 votes
from heat-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>`_.