openstack/cloudkitty-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: #38517
Change-Id: I8a5dbb8b2614119d19c37ef197db3809d2d5a50d
This commit is contained in:
Ghanshyam Mann 2021-05-13 09:55:35 -05:00 committed by Ghanshyam
parent d9b5aade5f
commit 984fd8f624
2 changed files with 60 additions and 11 deletions
CONTRIBUTING.rst
doc/source/contributor
contributing.rst

24
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://opendev.org/openstack/cloudkitty-tempest-plugin
https://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:
https://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 Storyboard:
Bugs should be filed on Storyboard, not GitHub:
https://storyboard.openstack.org/#!/project/914
https://storyboard.openstack.org/#!/project/890
For more specific information about contributing to this repository, see the
cloudkitty-tempest-plugin contributor guide:
https://docs.openstack.org/cloudkitty-tempest-plugin/latest/contributor/contributing.html

47
doc/source/contributor/contributing.rst Normal 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 cloudkitty-tempest-plugin.
Communication
~~~~~~~~~~~~~
* IRC channel #cloudkitty at OFTC
* Mailing list (prefix subjects with ``[cloudkitty]`` for faster responses)
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss
Contacting the Core Team
~~~~~~~~~~~~~~~~~~~~~~~~
Please refer the `cloudkitty-tempest-plugin Core Team
<https://review.opendev.org/admin/groups/4ac765c35f985b3ad9226da07fdcc205c1ce4fe1,members>`_ contacts.
New Feature Planning
~~~~~~~~~~~~~~~~~~~~
Cloudkitty features are tracked on `Storyboard <https://storyboard.openstack.org/#!/project/914>`_.
Task Tracking
~~~~~~~~~~~~~
We track our tasks in `Storyboard <https://storyboard.openstack.org/#!/project/914>`_.
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
`StoryBoard <https://storyboard.openstack.org/#!/project/914>`_.
Getting Your Patch Merged
~~~~~~~~~~~~~~~~~~~~~~~~~
All changes proposed to the cloudkitty-tempest-plugin project require one or two +2 votes
from cloudkitty-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>`_.