From ce3f97cecdf4e932cafdffae8f13d07756aed2db Mon Sep 17 00:00:00 2001 From: Ghanshyam Mann Date: Fri, 14 May 2021 14:46:05 -0500 Subject: [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: #38524 Change-Id: Ifbdf4c65a1e72ef3569439e5eadb836260a786d1 --- CONTRIBUTING.rst | 21 ++++++++------- doc/source/contributor/contributing.rst | 47 +++++++++++++++++++++++++++++++++ doc/source/index.rst | 10 +++++++ 3 files changed, 69 insertions(+), 9 deletions(-) create mode 100644 doc/source/contributor/contributing.rst diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 862ffd6..9b01b6c 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: - http://docs.openstack.org/infra/manual/developers.html + https://opendev.org/openstack/heat-cfntools -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. - 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 Storyboard not GitHub: +Bugs should be filed on Storyboard,: https://storyboard.openstack.org/#!/project/openstack/heat-cfntools + +For more specific information about contributing to this repository, see the +heat-cfntools contributor guide: + + https://docs.openstack.org/heat-cfntools/latest/contributor/contributing.html diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst new file mode 100644 index 0000000..d028315 --- /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 heat-cfntools. + +Communication +~~~~~~~~~~~~~ +* IRC channel #heat at OFTC +* Mailing list (prefix subjects with ``[heat]`` for faster responses) + http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss + +Contacting the Core Team +~~~~~~~~~~~~~~~~~~~~~~~~ +Please refer the `heat-cfntools Core Team +`_ contacts. + +New Feature Planning +~~~~~~~~~~~~~~~~~~~~ +heat-cfntools features are tracked on `Storyboard `_. +Please specify heat-cfntools in Storyboard. + +Task Tracking +~~~~~~~~~~~~~ +We track our tasks in `Storyboard `_. +Please specify heat-cfntools in Storyboard. + +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 heat-cfntools project require one or two +2 votes +from heat-cfntools 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 81b9277..da070bc 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -15,3 +15,13 @@ Heat cfntools cfn-init cfn-push-stats cfn-signal + +For Contributors +---------------- + +* If you are a new contributor to Heat cfntools please refer: :doc:`contributor/contributing` + + .. toctree:: + :hidden: + + contributor/contributing -- cgit v1.2.1