[community 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: #38536
Change-Id: I1d8ff80322deffb904d1bfe16b5a5ad9d4d9fc07
This commit is contained in:
Ghanshyam Mann 2021-05-14 16:39:05 -05:00 committed by Ghanshyam
parent ca6c1525a0
commit 44cae8ad7f
3 changed files with 69 additions and 10 deletions

View File

@ -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/masakari
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 Launchpad, not GitHub:
Bugs should be filed on Launchpad:
https://bugs.launchpad.net/masakari
For more specific information about contributing to this repository, see the
masakari contributor guide:
https://docs.openstack.org/masakari/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 masakari.
Communication
~~~~~~~~~~~~~
* IRC channel #openstack-masakari at OFTC
* Mailing list (prefix subjects with ``[masakari]`` for faster responses)
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss
Contacting the Core Team
~~~~~~~~~~~~~~~~~~~~~~~~
Please refer the `masakari Core Team
<https://review.opendev.org/admin/groups/23a3cb66b177425112e8d24b8f8b5a1c662cc9e5,members>`_ contacts.
New Feature Planning
~~~~~~~~~~~~~~~~~~~~
masakari features are tracked on `Launchpad <https://bugs.launchpad.net/masakari>`_.
Task Tracking
~~~~~~~~~~~~~
We track our tasks in `Launchpad <https://bugs.launchpad.net/masakari>`_.
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/masakari>`_.
Getting Your Patch Merged
~~~~~~~~~~~~~~~~~~~~~~~~~
All changes proposed to the masakari project require one or two +2 votes
from masakari 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

@ -88,6 +88,16 @@ Reference Material
user/notifications.rst
user/process.rst
For Contributors
================
* If you are a new contributor to Masakari please refer: :doc:`contributor/contributing`
.. toctree::
:hidden:
contributor/contributing
Search
======