From 72272fe978a8af6e098e1bad58cee5748812d616 Mon Sep 17 00:00:00 2001 From: Ghanshyam Mann Date: Thu, 13 May 2021 17:40:02 -0500 Subject: [PATCH] [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: #38519 Change-Id: Ia738b3f37d1b0a477838c37a91afca14108f85e3 --- CONTRIBUTING.rst | 24 ++++++------ doc/source/contributor/contributing.rst | 51 +++++++++++++++++++++++-- doc/source/contributor/index.rst | 9 ----- doc/source/index.rst | 11 +++++- 4 files changed, 70 insertions(+), 25 deletions(-) delete mode 100644 doc/source/contributor/index.rst diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index a08f21b..0e79687 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,17 +1,19 @@ -If you would like to contribute to the development of OpenStack, you must -follow the steps in this page: +The source repository for this project can be found at: - http://docs.openstack.org/infra/manual/developers.html + https://opendev.org/openstack/python-cyborgclient -If you already have a good understanding of how the system works and your -OpenStack accounts are set up, you can skip to the development workflow -section of this documentation to learn how changes to OpenStack should be -submitted for review via the Gerrit tool: +Pull requests submitted through GitHub are not monitored. - http://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-cyborgclient + https://bugs.launchpad.net/openstack-cyborg + +For more specific information about contributing to this repository, see the +python-cyborgclient contributor guide: + + https://docs.openstack.org//python-cyborgclient/latest/contributor/contributing.html diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst index 2aa0707..42529c4 100644 --- a/doc/source/contributor/contributing.rst +++ b/doc/source/contributor/contributing.rst @@ -1,4 +1,47 @@ -============ -Contributing -============ -.. include:: ../../../CONTRIBUTING.rst +============================ +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-cyborgclient. + +Communication +~~~~~~~~~~~~~ +* IRC channel #openstack-cyborg at OFTC +* Mailing list (prefix subjects with ``[cyborg]`` for faster responses) + http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss + +Contacting the Core Team +~~~~~~~~~~~~~~~~~~~~~~~~ +Please refer the `python-cyborgclient Core Team +`_ contacts. + +New Feature Planning +~~~~~~~~~~~~~~~~~~~~ +python-cyborgclient features are tracked on `Launchpad Bugs `_. + +Task Tracking +~~~~~~~~~~~~~ +We track our tasks in `Launchpad Bugs `_. +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 Bugs `_. + +Getting Your Patch Merged +~~~~~~~~~~~~~~~~~~~~~~~~~ +All changes proposed to the python-cyborgclient project require one or two +2 votes +from python-cyborgclient 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/contributor/index.rst b/doc/source/contributor/index.rst deleted file mode 100644 index 036e449..0000000 --- a/doc/source/contributor/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -=========================== - Contributor Documentation -=========================== - -.. toctree:: - :maxdepth: 2 - - contributing - diff --git a/doc/source/index.rst b/doc/source/index.rst index b71783e..73b2968 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -15,12 +15,21 @@ Contents: readme install/index library/index - contributor/index cli/index user/index admin/index reference/index +For Contributors +================ + +* If you are a new contributor to python-cyborgclient please refer: :doc:`contributor/contributing` + + .. toctree:: + :hidden: + + contributor/contributing + Indices and tables ==================