[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: #38524
Change-Id: I61e494a5eb65b0a4f435eea2e511be0c398b7990
Ghanshyam Mann 2021-05-14 14:46:01 -05:00 committed by Ghanshyam
parent f9b3be622f
commit 5247b8f6f3
3 changed files with 63 additions and 34 deletions

View File

@ -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:
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.
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.
Bugs should be filed on StoryBoard, not GitHub and Launchpad:
Bugs should be filed on Storyboard,:
For more specific information about contributing to this repository, see the
heat-dashboard contributor guide:

View File

@ -1,30 +1,47 @@
How to Contribute
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-dashboard.
Contributor License Agreement
* IRC channel #heat at OFTC
* Mailing list (prefix subjects with ``[heat]`` for faster responses)
.. index::
single: license; agreement
Contacting the Core Team
Please refer the `heat-dashboard Core Team
<https://review.opendev.org/admin/groups/8803fcad46b4bce76ed436861474878f36e0a8e4,members>`_ contacts.
In order to contribute to the Heat Dashboard project, you need to have
signed OpenStack's contributor's agreement.
New Feature Planning
heat-dashboard features are tracked on `Storyboard <https://storyboard.openstack.org/#!/project/openstack/heat-dashboard>`_.
.. seealso::
Task Tracking
We track our tasks in `Storyboard <https://storyboard.openstack.org/#!/project/openstack/heat-dashboard>`_.
If you're looking for some smaller, easier work item to pick up and get started
on, search for the 'low-hanging-fruit' tag.
* https://docs.openstack.org/infra/manual/developers.html
* https://wiki.openstack.org/CLA
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-dashboard>`_.
Getting Your Patch Merged
All changes proposed to the heat-dashboard project require one or two +2 votes
from heat-dashboard core reviewers before one of the core reviewers can approve
patch by giving ``Workflow +1`` vote.
Project Hosting Details
Bug tracker
Code Hosting
Code Review
Project Team Lead Duties
All common PTL duties are enumerated in the `PTL guide

View File

@ -17,3 +17,13 @@ Contents
Configuration Guide <configuration/index>
User Documentation <user/index>
For Contributors
* If you are a new contributor to heat-dashboard please refer: :doc:`contributor/contributing`
.. toctree::