[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: #38539 Change-Id: I12ddfc0d4332ea19b5b0abab5cac61653726e3d1
This commit is contained in:
parent
c3bda9eeb1
commit
bb65fc6402
@ -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/yaql
|
||||||
|
|
||||||
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/yaql
|
https://bugs.launchpad.net/yaql
|
||||||
|
|
||||||
|
For more specific information about contributing to this repository, see the
|
||||||
|
yaql contributor guide:
|
||||||
|
|
||||||
|
https://docs.openstack.org/yaql/latest/contributor/contributing.html
|
||||||
|
@ -1,4 +0,0 @@
|
|||||||
============
|
|
||||||
Contributing
|
|
||||||
============
|
|
||||||
.. include:: ../../CONTRIBUTING.rst
|
|
47
doc/source/contributor/contributing.rst
Normal file
47
doc/source/contributor/contributing.rst
Normal 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 yaql.
|
||||||
|
|
||||||
|
Communication
|
||||||
|
~~~~~~~~~~~~~
|
||||||
|
* IRC channel #murano at OFTC
|
||||||
|
* Mailing list (prefix subjects with ``[murano]`` for faster responses)
|
||||||
|
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss
|
||||||
|
|
||||||
|
Contacting the Core Team
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
Please refer the `yaql Core Team
|
||||||
|
<https://review.opendev.org/admin/groups/cba4f6fd54c3cc0d5706fc50b5ebd758860d02b8,members>`_ contacts.
|
||||||
|
|
||||||
|
New Feature Planning
|
||||||
|
~~~~~~~~~~~~~~~~~~~~
|
||||||
|
yaql features are tracked on `Launchpad <https://bugs.launchpad.net/yaql>`_.
|
||||||
|
|
||||||
|
Task Tracking
|
||||||
|
~~~~~~~~~~~~~
|
||||||
|
We track our tasks in `Launchpad <https://bugs.launchpad.net/yaql>`_.
|
||||||
|
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/yaql>`_.
|
||||||
|
|
||||||
|
Getting Your Patch Merged
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
All changes proposed to the yaql project require one or two +2 votes
|
||||||
|
from yaql 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>`_.
|
@ -24,8 +24,12 @@ Welcome to yaql documentation!
|
|||||||
|
|
||||||
standard_library
|
standard_library
|
||||||
|
|
||||||
.. toctree::
|
For Contributors
|
||||||
|
================
|
||||||
|
|
||||||
contributing
|
* If you are a new contributor to Yaql please refer: :doc:`contributor/contributing`
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:hidden:
|
||||||
|
|
||||||
|
contributor/contributing
|
||||||
|
Loading…
Reference in New Issue
Block a user