[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: If8017854d98fb0fc071d6afe23f6111da25aa8e4
This commit is contained in:
parent
812ee9e3f8
commit
6185adefac
@ -16,4 +16,4 @@ Bugs should be filed on Launchpad:
|
||||
For more specific information about contributing to this repository, see the
|
||||
openstack-ansible contributor guide:
|
||||
|
||||
https://docs.openstack.org/openstack-ansible/latest/contributor/contribute.html
|
||||
https://docs.openstack.org/openstack-ansible/latest/contributor/contributing.html
|
||||
|
105
doc/source/contributor/contributing.rst
Normal file
105
doc/source/contributor/contributing.rst
Normal file
@ -0,0 +1,105 @@
|
||||
============================
|
||||
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 OpenStack-Ansible.
|
||||
|
||||
Communication
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
IRC channel
|
||||
^^^^^^^^^^^
|
||||
|
||||
The OpenStack-Ansible community communicates in the #openstack-ansible IRC
|
||||
channel hosted on freenode. This channel is logged, and its logs are published
|
||||
on http://eavesdrop.openstack.org/irclogs/%23openstack-ansible/.
|
||||
|
||||
Weekly meetings are held in our IRC channel. The schedule and
|
||||
logs can be found on
|
||||
http://eavesdrop.openstack.org/#OpenStack_Ansible_Deployment_Meeting.
|
||||
The agenda for the next meeting can be found on our
|
||||
`Meetings wiki page <https://wiki.openstack.org/wiki/Meetings/openstack-ansible>`_.
|
||||
|
||||
Mailing lists
|
||||
^^^^^^^^^^^^^
|
||||
|
||||
Members of the OpenStack-Ansible community should monitor the
|
||||
**OpenStack-discuss** `mailing lists`_.
|
||||
|
||||
.. _mailing lists: http://lists.openstack.org/cgi-bin/mailman/listinfo
|
||||
|
||||
All our communications should be prefixed with **[openstack-ansible]**.
|
||||
|
||||
Contacting the Core Team
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
All of our core team is available through IRC and present in #openstack-ansible
|
||||
channel on Freenode. The list of the current members of the OpenStack-Ansible Team
|
||||
might be found on `gerrit`_.
|
||||
|
||||
.. _gerrit: https://review.opendev.org/#/admin/groups/490,members
|
||||
|
||||
|
||||
New Feature Planning
|
||||
~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
If you would like to contribute towards a role to introduce an OpenStack
|
||||
or infrastructure service, or to improve an existing role, the
|
||||
OpenStack-Ansible project would welcome that contribution and your assistance
|
||||
in maintaining it.
|
||||
|
||||
Please look through :dev_docs:`Contributor Guidelines <contributor/contribute.html>`
|
||||
page for more information about the process.
|
||||
|
||||
|
||||
Task Tracking
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
We track our tasks in Launchpad
|
||||
|
||||
https://bugs.launchpad.net/openstack-ansible
|
||||
|
||||
|
||||
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/openstack-ansible>`_.
|
||||
|
||||
|
||||
Also you may find more detailed information about how to work with bugs
|
||||
on the page :dev_docs:`Bug Handling <contributor/bugs.html>`
|
||||
|
||||
|
||||
Getting Your Patch Merged
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Any new code will be reviewed before merging into our repositories and
|
||||
requires at least 2 approvals from our Core team.
|
||||
|
||||
We follow openstack guidelines for the `code reviewing <https://docs.openstack.org/project-team-guide/review-the-openstack-way.html>`_ process.
|
||||
|
||||
Please be aware that any patch can be refused by the community if they
|
||||
don't match the :ref:`codeguidelines`.
|
||||
|
||||
|
||||
Project Team Lead Duties
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
All common PTL duties are enumerated in the `PTL guide
|
||||
<https://docs.openstack.org/project-team-guide/ptl.html>`_.
|
||||
|
||||
All Core reviewer duties are described on the page
|
||||
:dev_docs:`Core Reviewers <contributor/core-reviewers.html>`.
|
@ -21,6 +21,7 @@ OpenStack-Ansible Ussuri is currently in development.
|
||||
Release notes <https://docs.openstack.org/releasenotes/openstack-ansible/unreleased.html>
|
||||
admin/index
|
||||
user/index
|
||||
contributor/contributing
|
||||
contributor/index
|
||||
reference/index
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user