From ffa67c1e64fb6b9eae32c569b0b3f057ebc14850 Mon Sep 17 00:00:00 2001 From: Ghanshyam Mann Date: Fri, 14 May 2021 17:12:07 -0500 Subject: [PATCH] [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 --- CONTRIBUTING.rst | 21 ++++++----- doc/source/contributor/contributing.rst | 47 +++++++++++++++++++++++++ doc/source/index.rst | 15 ++++---- 3 files changed, 66 insertions(+), 17 deletions(-) create mode 100644 doc/source/contributor/contributing.rst diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 78350dc3..1b3fa035 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -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 diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst new file mode 100644 index 00000000..35b4fb5f --- /dev/null +++ b/doc/source/contributor/contributing.rst @@ -0,0 +1,47 @@ +============================ +So You Want to Contribute... +============================ +For general information on contributing to OpenStack, please check out the +`contributor guide `_ 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 +`_ contacts. + +New Feature Planning +~~~~~~~~~~~~~~~~~~~~ +python-mistralclient features are tracked on `Launchpad `_. + +Task Tracking +~~~~~~~~~~~~~ +We track our tasks in `Launchpad `_. +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 `_. + +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 +`_. diff --git a/doc/source/index.rst b/doc/source/index.rst index 371e06e9..95208921 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -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