From 7f1627348aa8a3d51e65f06b1903488eb8a1d098 Mon Sep 17 00:00:00 2001 From: Wes Hayutin Date: Tue, 28 Apr 2020 16:06:51 -0600 Subject: [PATCH] [Community goal] Update contributor documentation As the Ussuri goal we have an OpenStack project wide contributing documentation template [1]. pyhton-novaclient use its own bug or feature tracking LP and core team is also not exactly same as nova so adding its own contributor guide with keeping common links from nova with python-novaclient specific information. Also the top level CONTRIBUTING.rst template has been changed in the cookiecutter repo[2]. So this patch updates the CONTRIBUTING.rst according to the new template. [1] https://opendev.org/openstack/cookiecutter/src/branch/master/%7b%7bcookiecutter.repo_name%7d%7d/doc/source/contributor/contributing.rst [2] https://review.opendev.org/#/c/696001 Change-Id: Ie255a2f3e358323da1132d3c7354651ea7719ae0 Story: #2007236 Task: #38567 --- ...ontributing.rst => contributing_roles.rst} | 0 doc/source/contributor/contributing.rst | 67 +++++++++++++++++++ doc/source/index.rst | 3 +- 3 files changed, 69 insertions(+), 1 deletion(-) rename doc/source/{contributing.rst => contributing_roles.rst} (100%) create mode 100644 doc/source/contributor/contributing.rst diff --git a/doc/source/contributing.rst b/doc/source/contributing_roles.rst similarity index 100% rename from doc/source/contributing.rst rename to doc/source/contributing_roles.rst diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst new file mode 100644 index 000000000..d7e50a2e5 --- /dev/null +++ b/doc/source/contributor/contributing.rst @@ -0,0 +1,67 @@ +============================ +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. + +The information below will cover the project specific information you need to get started with TripleO. + +Documentation +~~~~~~~~~~~~~ +Documentation for the TripleO project can be found `here `_ + +Communication +~~~~~~~~~~~~~ +* IRC channel ``#tripleo`` at FreeNode +* Mailing list (prefix subjects with ``[tripleo]`` for faster responses) + http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss + +Contacting the Core Team +~~~~~~~~~~~~~~~~~~~~~~~~ +Please refer to the `TripleO Core Team +`_ contacts. + +New Feature Planning +~~~~~~~~~~~~~~~~~~~~ +If you want to propose a new feature please read our `Example Spec `_ + +Submit your feature to the `proper branch `_. + +TripleO features are tracked on `Launchpad BP `_. + +New TripleO Policy Proposal +~~~~~~~~~~~~~~~~~~~~~~~~~~~ +New policies can be proposed by submitting a policy-template +in the same way a spec file is submitted. + +Task Tracking +~~~~~~~~~~~~~ +We track our tasks in `Launchpad `_ and in +`StoryBoard `_ + +Reporting a Bug +~~~~~~~~~~~~~~~ +You found an issue and want to make sure we are aware of it? You can do so on +`Launchpad `__. +More info about Launchpad usage can be found on `OpenStack docs page +`_ + +Getting Your Patch Merged +~~~~~~~~~~~~~~~~~~~~~~~~~ +All changes proposed to the TripleO requires two ``Code-Review +2`` votes from +TripleO 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 +`_. + +The Release Process for TripleO is documented in `Release Management +`_. + +Documentation for the TripleO project can be found `here `_ diff --git a/doc/source/index.rst b/doc/source/index.rst index 2c31afc1c..1e5e1bdc2 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -11,8 +11,9 @@ Contents: .. toctree:: :maxdepth: 2 + contributor/contributing installation - contributing + contributing_roles usage roles modules