[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: #38522
Change-Id: I20b2d85bee7d32b6ad4970d7ccd47af6cdc3b930
changes/30/791330/2
Ghanshyam Mann 2 years ago committed by Ghanshyam
parent 2fe404f68f
commit f10f3aea74

@ -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://docs.openstack.org/infra/manual/developers.html
https://opendev.org/openstack/python-freezerclient
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.
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-freezerclient
For more specific information about contributing to this repository, see the
python-freezerclient contributor guide:
https://docs.openstack.org/python-freezerclient/latest/contributor/contributing.html

@ -0,0 +1,48 @@
============================
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-freezerclient.
Communication
~~~~~~~~~~~~~
* IRC channel #openstack-freezer at OFTC
* Mailing list (prefix subjects with ``[freezer]`` for faster responses)
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss
Contacting the Core Team
~~~~~~~~~~~~~~~~~~~~~~~~
Please refer the `python-freezerclient Core Team
<https://review.opendev.org/admin/groups/489539270c16cfb7990bb3f1a0f62f3e45a94635,members>`_ contacts.
New Feature Planning
~~~~~~~~~~~~~~~~~~~~
python-freezerclient features are tracked on `Storyboard <https://storyboard.openstack.org/#!/project/openstack/python-freezerclient>`_.
Task Tracking
~~~~~~~~~~~~~
We track our tasks in `Storyboard <https://storyboard.openstack.org/#!/project/openstack/python-freezerclient>`_.
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/openstack/python-freezerclient>`_.
Getting Your Patch Merged
~~~~~~~~~~~~~~~~~~~~~~~~~
All changes proposed to the python-freezerclient project require one or two +2 votes
from python-freezerclient 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>`_.

@ -1,17 +0,0 @@
===================
Contributor Guide
===================
Code is hosted at `git.openstack.org`__. Submit bugs to the python-freezerclient
project on `Launchpad`__. Submit code to the `openstack/python-freezerclient`
project using `Gerrit`__.
__ https://opendev.org/openstack/python-freezerclient
__ https://storyboard.openstack.org/#!/project/openstack/freezer-api
__ https://docs.openstack.org/infra/manual/developers.html#development-workflow
.. toctree::
:maxdepth: 2
testing

@ -11,8 +11,16 @@ Contents
user/index
reference/index
cli/index
contributor/index
For Contributors
================
* If you are a new contributor to python-freezerclient please refer: :doc:`contributor/contributing`
.. toctree::
:hidden:
contributor/contributing
Indices and tables
------------------

Loading…
Cancel
Save