From 3b02d94c884ea6c7182e08cbecf7e024a3541343 Mon Sep 17 00:00:00 2001 From: Ghanshyam Mann Date: Thu, 13 May 2021 09:55:51 -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: #38517 Change-Id: I04440027a475b13e728e8fc5d2c4b632623f3b47 --- CONTRIBUTING.rst | 23 ++++++------ doc/source/contributing.rst | 4 --- doc/source/contributor/contributing.rst | 47 +++++++++++++++++++++++++ doc/source/index.rst | 11 +++++- 4 files changed, 70 insertions(+), 15 deletions(-) delete mode 100644 doc/source/contributing.rst create mode 100644 doc/source/contributor/contributing.rst diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index c1ead80..4b602d6 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 in this page: +The source repository for this project can be found at: + + https://opendev.org/openstack/cloudkitty-dashboard - https://docs.openstack.org/infra/manual/developers.html +Pull requests submitted through GitHub are not monitored. -Once those steps have been completed, changes to OpenStack -should be submitted for review via the Gerrit tool, following -the workflow documented at: +To start contributing to OpenStack, follow the steps in the contribution guide +to set up and use Gerrit: - https://docs.openstack.org/infra/manual/developers.html#development-workflow + https://docs.openstack.org/contributors/code-and-documentation/quick-start.html -Pull requests submitted through GitHub will be ignored. - -Bugs should be filed on Storyboard, not GitHub: +Bugs should be filed on Storyboard: https://storyboard.openstack.org/#!/project/891 + +For more specific information about contributing to this repository, see the +cloudkitty-dashboard contributor guide: + + https://docs.openstack.org/cloudkitty-dashboard/latest/contributor/contributing.html diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst deleted file mode 100644 index 1728a61..0000000 --- a/doc/source/contributing.rst +++ /dev/null @@ -1,4 +0,0 @@ -============ -Contributing -============ -.. include:: ../../CONTRIBUTING.rst diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst new file mode 100644 index 0000000..872d025 --- /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 cloudkitty-dashboard. + +Communication +~~~~~~~~~~~~~ +* IRC channel #cloudkitty at FreeNode +* Mailing list (prefix subjects with ``[cloudkitty]`` for faster responses) + http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss + +Contacting the Core Team +~~~~~~~~~~~~~~~~~~~~~~~~ +Please refer the `cloudkitty-dashboard Core Team +`_ contacts. + +New Feature Planning +~~~~~~~~~~~~~~~~~~~~ +Cloudkitty features are tracked on `Storyboard `_. + +Task Tracking +~~~~~~~~~~~~~ +We track our tasks in `Storyboard `_. +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 +`StoryBoard `_. + +Getting Your Patch Merged +~~~~~~~~~~~~~~~~~~~~~~~~~ +All changes proposed to the cloudkitty-dashboard project require one or two +2 votes +from cloudkitty-dashboard 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 8471f77..840cb80 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -13,7 +13,16 @@ Contents: readme installation - contributing + +For Contributors +================ + +* If you are a new contributor to cloudkitty-dashboard please refer: :doc:`contributor/contributing` + + .. toctree:: + :hidden: + + contributor/contributing Indices and tables ==================