From 3bf875febfccc6e578646a8453e545bcb262b4f2 Mon Sep 17 00:00:00 2001 From: Ghanshyam Mann Date: Mon, 17 May 2021 19:25:00 -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: #38556 Change-Id: I0b404a71955222427bc1b4bd2e6e93c6ad0ea89a --- CONTRIBUTING.rst | 27 +++++++++------- doc/source/contributor/contributing.rst | 42 +++++++++++++++++++++++++ doc/source/contributor/index.rst | 5 --- doc/source/index.rst | 11 ++++++- 4 files changed, 68 insertions(+), 17 deletions(-) create mode 100644 doc/source/contributor/contributing.rst delete mode 100644 doc/source/contributor/index.rst diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 5dac14e..4fc06b9 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,14 +1,19 @@ -If you would like to contribute to the development of OpenStack, start by -following the steps in this page: -https://docs.openstack.org/infra/manual/developers.html +The source repository for this project can be found at: -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: -https://docs.openstack.org/infra/manual/developers.html#development-workflow + https://opendev.org/openstack/reno -Pull requests submitted through GitHub will be ignored. +Pull requests submitted through GitHub are not monitored. -Bugs should be filed on Storyboard, not GitHub: -https://storyboard.openstack.org/#!/project/933 +To start contributing to OpenStack, follow the steps in the contribution guide +to set up and use Gerrit: + + https://docs.openstack.org/contributors/code-and-documentation/quick-start.html + +Bugs should be filed on Storyboard: + + https://storyboard.openstack.org/#!/project/933 + +For more specific information about contributing to this repository, see the +reno contributor guide: + + https://docs.openstack.org/reno/latest/contributor/contributing.html diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst new file mode 100644 index 0000000..51e611b --- /dev/null +++ b/doc/source/contributor/contributing.rst @@ -0,0 +1,42 @@ +============================ +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 Reno. + +Communication +~~~~~~~~~~~~~ +* IRC channel #openstack-release at FreeNode +* Mailing list (prefix subjects with ``[release]`` for faster responses) + http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss + +Contacting the Core Team +~~~~~~~~~~~~~~~~~~~~~~~~ +Please refer the `reno Core Team +`_ contacts. + +New Feature Planning +~~~~~~~~~~~~~~~~~~~~ +reno 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 reno project require one or two +2 votes +from reno core reviewers before one of the core reviewers can approve +patch by giving ``Workflow +1`` vote. diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst deleted file mode 100644 index 3d4ceb4..0000000 --- a/doc/source/contributor/index.rst +++ /dev/null @@ -1,5 +0,0 @@ -============ -Contributing -============ - -.. include:: ../../../CONTRIBUTING.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index 911f975..753f1de 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -18,5 +18,14 @@ Contents user/index install/index - contributor/index releasenotes/index + +For Contributors +================ + +* If you are a new contributor to Reno please refer: :doc:`contributor/contributing` + + .. toctree:: + :hidden: + + contributor/contributing