[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

Change-Id: I4407ab803cf3dfd66ab3c5b25f8f0db85147cdc5
This commit is contained in:
wanghao 2021-06-15 10:11:51 +08:00
parent cbaadc0e23
commit fad3fa1416
3 changed files with 60 additions and 9 deletions

View File

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

@ -93,6 +93,7 @@ Contents
admin/index admin/index
install/index install/index
configuration/index configuration/index
contributor/contributing
contributor/index contributor/index
cli/index cli/index