[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: Ifbdf4c65a1e72ef3569439e5eadb836260a786d1
This commit is contained in:
parent
c32963fdea
commit
ce3f97cecd
@ -1,16 +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:
|
||||
|
||||
http://docs.openstack.org/infra/manual/developers.html
|
||||
https://opendev.org/openstack/heat-cfntools
|
||||
|
||||
Once those steps have been completed, changes to OpenStack
|
||||
should be submitted for review via the Gerrit tool, following
|
||||
the workflow documented at:
|
||||
Pull requests submitted through GitHub are not monitored.
|
||||
|
||||
http://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 Storyboard,:
|
||||
|
||||
https://storyboard.openstack.org/#!/project/openstack/heat-cfntools
|
||||
|
||||
For more specific information about contributing to this repository, see the
|
||||
heat-cfntools contributor guide:
|
||||
|
||||
https://docs.openstack.org/heat-cfntools/latest/contributor/contributing.html
|
||||
|
47
doc/source/contributor/contributing.rst
Normal file
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 heat-cfntools.
|
||||
|
||||
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-cfntools Core Team
|
||||
<https://review.opendev.org/admin/groups/b4b16f97f2b8416cb0111c0bec5df885bd779347,members>`_ contacts.
|
||||
|
||||
New Feature Planning
|
||||
~~~~~~~~~~~~~~~~~~~~
|
||||
heat-cfntools features are tracked on `Storyboard <https://storyboard.openstack.org/#!/project/openstack/heat>`_.
|
||||
Please specify heat-cfntools in Storyboard.
|
||||
|
||||
Task Tracking
|
||||
~~~~~~~~~~~~~
|
||||
We track our tasks in `Storyboard <https://storyboard.openstack.org/#!/project/openstack/heat>`_.
|
||||
Please specify heat-cfntools in Storyboard.
|
||||
|
||||
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>`_.
|
||||
|
||||
Getting Your Patch Merged
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
All changes proposed to the heat-cfntools project require one or two +2 votes
|
||||
from heat-cfntools 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>`_.
|
@ -15,3 +15,13 @@ Heat cfntools
|
||||
cfn-init
|
||||
cfn-push-stats
|
||||
cfn-signal
|
||||
|
||||
For Contributors
|
||||
----------------
|
||||
|
||||
* If you are a new contributor to Heat cfntools please refer: :doc:`contributor/contributing`
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
contributor/contributing
|
||||
|
Loading…
x
Reference in New Issue
Block a user