[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: #38554

Change-Id: Ia46983955ddc183824d9088c1a6c3e307af188c3
This commit is contained in:
Ghanshyam Mann 2020-04-19 17:45:09 -05:00
parent f8a57d6583
commit 7b7ba01d5b
3 changed files with 75 additions and 9 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:
http://docs.openstack.org/infra/manual/developers.html https://opendev.org/openstack/hacking
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:
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 Launchpad, not GitHub: Bugs should be filed on Launchpad:
https://bugs.launchpad.net/hacking https://bugs.launchpad.net/hacking
For more specific information about contributing to this repository, see the
Hacking contributor guide:
https://docs.openstack.org/hacking/latest/contributor/contributing.html

View File

@ -0,0 +1,55 @@
============================
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 Hacking.
Communication
~~~~~~~~~~~~~
* IRC channel ``#openstack-qa`` at FreeNode
* Mailing list (prefix subjects with ``[qa]`` for faster responses)
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss
Contacting the Core Team
~~~~~~~~~~~~~~~~~~~~~~~~
Please refer to the `Hacking Core Team
<https://review.opendev.org/#/admin/groups/153,members>`_ contacts.
New Feature Planning
~~~~~~~~~~~~~~~~~~~~
If you want to propose a new feature please read `Feature Proposal Process`_
Hacking features are tracked on `Launchpad BP <https://blueprints.launchpad.net/hacking>`_.
Task Tracking
~~~~~~~~~~~~~
We track our tasks in `Launchpad <https://bugs.launchpad.net/hacking>`_.
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/hacking/+filebug>`__.
More info about Launchpad usage can be found on `OpenStack docs page
<https://docs.openstack.org/contributors/common/task-tracking.html#launchpad>`_
Getting Your Patch Merged
~~~~~~~~~~~~~~~~~~~~~~~~~
All changes proposed to the Hacking requires two ``Code-Review +2`` votes from
Hacking 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>`_.
The Release Process for QA is documented in `QA Release Process
<https://wiki.openstack.org/wiki/QA/releases>`_.
.. _Feature Proposal Process: https://wiki.openstack.org/wiki/QA#Feature_Proposal_.26_Design_discussions

View File

@ -8,7 +8,15 @@ Hacking pins its dependencies, as a new release of some dependency can break
hacking based gating jobs. This is because new versions of dependencies can hacking based gating jobs. This is because new versions of dependencies can
introduce new rules, or make existing rules stricter. introduce new rules, or make existing rules stricter.
* Contributing: If you are a new contributor to Hacking please refer: :doc:`contributor/contributing`
.. toctree:: .. toctree::
:maxdepth: 3 :maxdepth: 3
user/index user/index
.. toctree::
:hidden:
contributor/contributing