openstack/keystone
Code Issues Proposed changes

Community goal: Adding contributing.rst

Browse Source 
http://lists.openstack.org/pipermail/openstack-discuss/2020-February/012364.html

Change-Id: Ifc74072a5b7ae90910100093450e89f98d5dcb53
This commit is contained in:
Vishakha Agarwal 2020-03-25 01:26:59 +05:30
parent 9f9040257f
commit 143f07f545
2 changed files with 75 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

74
doc/source/contributor/contributing.rst Normal file
View File

@ -0,0 +1,74 @@
============================
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 Keystone.
Communication
~~~~~~~~~~~~~~
For communicating with Keystone Team, you can `reach out`_ to us through mailing lists
and IRC channels.
.. _reach out: https://docs.openstack.org/keystone/latest/getting-started/community.html
Contacting the Core Team
~~~~~~~~~~~~~~~~~~~~~~~~~
For any help contact `keystone maintainers`_ , the core team of keystone.
.. _keystone maintainers: https://review.opendev.org/#/admin/groups/9,members
New Feature Planning
~~~~~~~~~~~~~~~~~~~~
If you are planning to propose a feature in keystone , check out `Proposing Features`_
.. _Proposing Features: https://docs.openstack.org/keystone/latest/contributor/proposing-features.html
Task Tracking
~~~~~~~~~~~~~~
We track our tasks in `keystone bug tracker`_. You can also track the tasks of other
keystone repositories also.
* `keystonemiddleware <https://bugs.launchpad.net/keystonemiddleware/+bugs?field.status=New>`__
* `keystoneauth <https://bugs.launchpad.net/keystoneauth/+bugs?field.status=New>`__
* `python-keystoneclient <https://bugs.launchpad.net/python-keystoneclient/+bugs?field.status=New>`__
If you're looking for some smaller, easier work item to pick up and get started
on, search for the `low-hanging-fruit`_ tag in `bugs launchpad`_.
.. _keystone bug tracker: https://bugs.launchpad.net/keystone/+bugs?field.status=New
.. _low-hanging-fruit: https://docs.openstack.org/keystone/train/contributor/how-can-i-help.html#the-meaning-of-low-hanging-fruit
.. _bugs launchpad: https://bugs.launchpad.net/keystone/+bugs?field.tag=low-hanging-fruit
Reporting a Bug
~~~~~~~~~~~~~~~
You found an issue and want to make sure we are aware of it? You can do so
in `keystone bug tracker`_ by following the `bug triage <https://wiki.openstack.org/wiki/BugTriage>`_
procedure.
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 `keystone maintainers`_.
.. _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/contributor/index.rst
View File

@ -21,6 +21,7 @@ Contributor Documentation
.. toctree::
:maxdepth: 1
contributing.rst
how-can-i-help.rst
set-up-keystone.rst
http-api.rst