From e4c433dacbac7f975994b9c023610205f9f9ab93 Mon Sep 17 00:00:00 2001 From: Ghanshyam Mann Date: Fri, 14 May 2021 15:57:28 -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 Adding noop jobs also to merge these *.rst only changes. Story: #2007236 Task: #38524 Change-Id: Id40407adab666a9b7591612fe0ae237aa07c9175 --- .zuul.yaml | 3 ++ CONTRIBUTING.rst | 21 ++++++----- doc/source/contributor/contributing.rst | 48 +++++++++++++++++++++++++ 3 files changed, 63 insertions(+), 9 deletions(-) create mode 100644 doc/source/contributor/contributing.rst diff --git a/.zuul.yaml b/.zuul.yaml index fa2f64c3..2eac4b47 100644 --- a/.zuul.yaml +++ b/.zuul.yaml @@ -51,6 +51,9 @@ check: jobs: - heat-templates-check + # This is added to merge *.rst only changes + - noop gate: jobs: - heat-templates-check + - noop diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 2a6a2208..ace1561c 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://docs.openstack.org/infra/manual/developers.html + https://opendev.org/openstack/heat-templates -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 Storyboard, not GitHub: +Bugs should be filed on Storyboard,: https://storyboard.openstack.org/#!/project/openstack/heat-templates + +For more specific information about contributing to this repository, see the +heat-templates contributor guide: + + https://opendev.org/openstack/heat-templates/src/branch/master/doc/source/contributor/contributing.rst diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst new file mode 100644 index 00000000..c2ae3f93 --- /dev/null +++ b/doc/source/contributor/contributing.rst @@ -0,0 +1,48 @@ +============================ +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-templates. + +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-templates Core Team +`_ contacts. + +New Feature Planning +~~~~~~~~~~~~~~~~~~~~ +heat-templates features are tracked on `Storyboard `_. +Please specify the reported story with `heat-templates`. + +Task Tracking +~~~~~~~~~~~~~ +We track our tasks in `Storyboard `_. +Please specify the reported story with `heat-templates`. + +Reporting a Bug +~~~~~~~~~~~~~~~ +You found an issue and want to make sure we are aware of it? You can do so on +`Storyboard `_. +Please specify the reported story with `heat-templates`. + +Getting Your Patch Merged +~~~~~~~~~~~~~~~~~~~~~~~~~ +All changes proposed to the heat-templates project require one or two +2 votes +from heat-templates 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 +`_.