openstack/adjutant
Code Issues Proposed changes

Community goal contributing docs

Browse Source 
Change-Id: I71084e1b81d64d7afe0d14647177afeb223d4ed7
Story: #2007236
Task: #38513
This commit is contained in:
Adrian Turjak 2020-04-30 14:26:44 +12:00
parent 183a7deec8
commit 64e9a8bcd9
2 changed files with 66 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
doc/source/contributing.rst Normal file
View File

@ -0,0 +1,65 @@
============================
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 Adjutant.
Communication
~~~~~~~~~~~~~~
To communicate with the Adjutant Team, you can use the `mailing lists`_ with
``[adjutant]`` in the subject or get in touch with us directly via `IRC`_ in
the ``#openstack-adjutant`` channel.
.. _mailing lists: http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss
.. _IRC: https://docs.openstack.org/contributors/common/irc.html
Contacting the Core Team
~~~~~~~~~~~~~~~~~~~~~~~~~
The `Adjutant core`_ group will be happy to help, so feel free to reach out.
.. _Adjutant core: https://review.opendev.org/#/admin/groups/1790,members
New Feature Planning
~~~~~~~~~~~~~~~~~~~~
For new features that you are planning check out our `storyboard tasks`_ and
add a new describing your feature.
.. _storyboard tasks: https://storyboard.openstack.org/#!/project/openstack/adjutant
Task Tracking
~~~~~~~~~~~~~~
Our tasks are all tracked on storyboard, with related projects visiable at:
`Adjutant Group <https://storyboard.openstack.org/#!/project_group/adjutant>`__
Reporting a Bug
~~~~~~~~~~~~~~~
If you've found a bug and want to make us aware of it, open a new story
among our `storyboard tasks`_, and tag it as a bug.
Getting Your Patch Merged
~~~~~~~~~~~~~~~~~~~~~~~~~
After submitting a Patch, anyone can cooperate by `reviewing`_ the patch on
`gerrit`_. Finally, the patch will be `merged`_ by the `Adjutant core`_.
.. _gerrit: https://review.opendev.org/
.. _reviewing: https://docs.opendev.org/opendev/infra-manual/latest/developers.html#peer-review
.. _merged: https://docs.opendev.org/opendev/infra-manual/latest/developers.html#merging
Project Team Lead Duties
------------------------
All common PTL duties are enumerated here in the `PTL guide <https://docs.openstack.org/project-team-guide/ptl.html>`_.

1
doc/source/index.rst
View File

@ -5,6 +5,7 @@ Welcome to Adjutant's documentation!
.. toctree::
:maxdepth: 1
contributing
development
release-notes
devstack-guide