[ussuri][goal] Update contributor documentation
This patch updates/adds the contributor documentation to follow
the guidelines of the Ussuri cycle community goal[1].
[1]
Story:
Task:
MODIFY
CONTRIBUTING.rst
CONTRIBUTING.rst
-If you would like to contribute to the development of OpenStack,
-you must follow the steps documented at:
+The source repository for this project can be found at:
- https://docs.openstack.org/infra/manual/developers.html#development-workflow
+ https://opendev.org/openstack/python-heatclient
-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.
- 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 Storyboard,:
https://storyboard.openstack.org/#!/project/openstack/python-heatclient
+
+For more specific information about contributing to this repository, see the
+python-heatclient contributor guide:
+
+ https://docs.openstack.org/python-heatclient/latest/contributor/contributing.html
+

ADD
doc/source/contributor/contributing.rst
+============================
+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 python-heatclient.
+
+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 `python-heatclient Core Team
+<https://review.opendev.org/admin/groups/b4b16f97f2b8416cb0111c0bec5df885bd779347,members>`_ contacts.
+
+New Feature Planning
+~~~~~~~~~~~~~~~~~~~~
+python-heatclient features are tracked on `Storyboard <https://storyboard.openstack.org/#!/project/openstack/heat>`_.
+Please specify the reported story with `python-heatclient`.
+
+Task Tracking
+~~~~~~~~~~~~~
+We track our tasks in `Storyboard <https://storyboard.openstack.org/#!/project/openstack/heat>`_.
+Please specify the reported story with `python-heatclient`.
+
+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 `python-heatclient`.
+
+Getting Your Patch Merged
+~~~~~~~~~~~~~~~~~~~~~~~~~
+All changes proposed to the python-heatclient project require one or two +2 votes
+from python-heatclient 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>`_.

MODIFY
doc/source/index.rst
doc/source/index.rst
@@ -108,14 +108,12 @@ Man Pages
man/heat
-============
-Contributing
-============
+For Contributors
+================
-Code is mirrored `on GitHub`_. Submit bugs to the python-heatclient project on
-`Launchpad`_. Submit code to the openstack/python-heatclient project using
-`Gerrit`_.
+* If you are a new contributor to python-heatclient please refer: :doc:`contributor/contributing`
-.. _on GitHub: https://github.com/openstack/python-heatclient
-.. _Launchpad: https://launchpad.net/python-heatclient
-.. _Gerrit: https://docs.openstack.org/infra/manual/developers.html#development-workflow
+ .. toctree::
+ :hidden:
+
+ contributor/contributing

[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: If5d20838a653687a142134a9645254d9c51dba78