[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: I2a91b3917a3d119aec2f53cc3e65fa6cc73381c0
This commit is contained in:
Ghanshyam Mann 2021-05-14 15:56:41 -05:00 committed by Ghanshyam
parent 88988bba17
commit 0501264fa0
3 changed files with 70 additions and 10 deletions

View File

@ -1,16 +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:
https://docs.openstack.org/infra/manual/developers.html https://opendev.org/openstack/tosca-parser
Once those steps have been completed, changes to OpenStack Pull requests submitted through GitHub are not monitored.
should be submitted for review via the Gerrit tool, following
the workflow documented at:
https://docs.openstack.org/infra/manual/developers.html#development-workflow 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. https://docs.openstack.org/contributors/code-and-documentation/quick-start.html
Bugs should be filed on Storyboard, not GitHub: Bugs should be filed on Launchpad,:
https://storyboard.openstack.org/#!/project/998 https://bugs.launchpad.net/tosca-parser
For more specific information about contributing to this repository, see the
tosca-parser contributor guide:
https://docs.openstack.org/tosca-parser/latest/contributor/contributing.html

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 tosca-parser.
Communication
~~~~~~~~~~~~~
* IRC channel #heat at `OFTC <https://www.oftc.net/>`
* 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 `tosca-parser Core Team
<https://review.opendev.org/admin/groups/1f7855baf3cf14fedf72e443eef18d844bcd43fa>`_ contacts.
New Feature Planning
~~~~~~~~~~~~~~~~~~~~
tosca-parser features are tracked on `Launchpad <https://bugs.launchpad.net/tosca-parser>`_.
Task Tracking
~~~~~~~~~~~~~
We track our tasks in `Launchpad <https://bugs.launchpad.net/tosca-parser>`_.
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 <https://bugs.launchpad.net/tosca-parser>`_.
Getting Your Patch Merged
~~~~~~~~~~~~~~~~~~~~~~~~~
All changes proposed to the tosca-parser project require one or two +2 votes
from tosca-parser 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>`_.

View File

@ -31,6 +31,16 @@ Contents:
usage usage
contributing contributing
For Contributors
================
* If you are a new contributor to tosca-parser please refer: :doc:`contributor/contributing`
.. toctree::
:hidden:
contributor/contributing
Indices and tables Indices and tables
------------------ ------------------