openstack
/
python-mistralclient
Code Issues Proposed changes

[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: #38537
Change-Id: I01c5a3a5def5baa215413cea25fc5fda41fea2b6
This commit is contained in:
Ghanshyam Mann 2021-05-14 17:12:07 -05:00 committed by Ghanshyam
parent dba9c08593
commit ffa67c1e64
3 changed files with 66 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
CONTRIBUTING.rst
View File

@ -1,16 +1,19 @@
If you would like to contribute to the development of OpenStack,
you must follow the steps documented at:
The source repository for this project can be found at:
https://docs.openstack.org/infra/manual/developers.html
https://opendev.org/openstack/python-mistralclient
Once those steps have been completed, changes to OpenStack
should be submitted for review via the Gerrit tool, following
the workflow documented at:
Pull requests submitted through GitHub are not monitored.
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/python-mistralclient
For more specific information about contributing to this repository, see the
python-mistralclient contributor guide:
https://docs.openstack.org/python-mistralclient/latest/contributor/contributing.html

47
doc/source/contributor/contributing.rst Normal file
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 python-mistralclient.
Communication
~~~~~~~~~~~~~
* IRC channel #openstack-mistralclient at OFTC
* Mailing list (prefix subjects with ``[mistral]`` for faster responses)
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss
Contacting the Core Team
~~~~~~~~~~~~~~~~~~~~~~~~
Please refer the `python-mistralclient Core Team
<https://review.opendev.org/admin/groups/19588f2c593d37749e32bc5400365f654c683d19,members>`_ contacts.
New Feature Planning
~~~~~~~~~~~~~~~~~~~~
python-mistralclient features are tracked on `Launchpad <https://bugs.launchpad.net/python-mistralclient>`_.
Task Tracking
~~~~~~~~~~~~~
We track our tasks in `Launchpad <https://bugs.launchpad.net/python-mistralclient>`_.
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/python-mistralclient>`_.
Getting Your Patch Merged
~~~~~~~~~~~~~~~~~~~~~~~~~
All changes proposed to the python-mistralclient project require one or two +2 votes
from python-mistralclient 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>`_.

15
doc/source/index.rst
View File

@ -29,13 +29,12 @@ Python API Reference
.. _REST API Specification: https://docs.openstack.org/mistral/latest/api/v2.html
Contributing
------------
For Contributors
----------------
Code is hosted `on GitHub`_. Submit bugs to the python-mistralclient project on
`Launchpad`_. Submit code to the openstack/python-mistralclient project
using `Gerrit`_.
* If you are a new contributor to python-mistralclient please refer: :doc:`contributor/contributing`
.. _on GitHub: https://github.com/openstack/python-mistralclient
.. _Launchpad: https://launchpad.net/python-mistralclient
.. _Gerrit: https://docs.openstack.org/infra/manual/developers.html#development-workflow
.. toctree::
:hidden:
contributor/contributing