From 772d75cc461226f364266a74210905339dac383b Mon Sep 17 00:00:00 2001 From: Ghanshyam Mann Date: Sun, 19 Apr 2020 17: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: #38554 Change-Id: Ie02405c3b89b8d5f338191b7d8e58853186b4938 --- CONTRIBUTING.rst | 22 +++++----- doc/source/contributor/contributing.rst | 58 +++++++++++++++++++++++++ doc/source/contributor/index.rst | 4 -- doc/source/index.rst | 9 +++- 4 files changed, 77 insertions(+), 16 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 f235094..a5916d9 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,17 +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/coverage2sql -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: +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 Launchpad, not GitHub: +Bugs should be filed on Launchpad: https://bugs.launchpad.net/coverage2sql + +For more specific information about contributing to this repository, see the +coverage2sql contributor guide: + + https://docs.openstack.org/coverage2sql/latest/contributor/contributing.html diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst new file mode 100644 index 0000000..979492b --- /dev/null +++ b/doc/source/contributor/contributing.rst @@ -0,0 +1,58 @@ +============================ +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 coverage2sql. + +Communication +~~~~~~~~~~~~~ +* IRC channel #openstack-qa at FreeNode +* Mailing list (prefix subjects with ``[qa]`` for faster responses) + http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss + +Contacting the Core Team +~~~~~~~~~~~~~~~~~~~~~~~~ +Please refer the `coverage2sql Core Team +`_ contacts. + +New Feature Planning +~~~~~~~~~~~~~~~~~~~~ +If you want to propose a new feature please read `Feature Proposal Process`_ +coverage2sql features are tracked on `Launchpad BP `_. + +Task Tracking +~~~~~~~~~~~~~ +We track our tasks in `Launchpad `_. + +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 +`Launchpad `__. +More info about Launchpad usage can be found on `OpenStack docs page +`_ + +Getting Your Patch Merged +~~~~~~~~~~~~~~~~~~~~~~~~~ +All changes proposed to the coverage2sql requires two ``Code-Review +2`` votes from +coverage2sql 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 +`_. + +Release Process fir QA is documented in `QA Release Process +`_. + +.. _Feature Proposal Process: https://wiki.openstack.org/wiki/QA#Feature_Proposal_.26_Design_discussions diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst deleted file mode 100644 index 2aa0707..0000000 --- a/doc/source/contributor/index.rst +++ /dev/null @@ -1,4 +0,0 @@ -============ -Contributing -============ -.. include:: ../../../CONTRIBUTING.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index 4f71244..70f774c 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -15,13 +15,18 @@ if your coverage rate is down. * Documentation: https://docs.openstack.org/coverage2sql/latest/ * Source: https://opendev.org/openstack/coverage2sql * Bugs: https://bugs.launchpad.net/coverage2sql +* Contributing: If you are a new contributor to coverage2sql please refer: :doc:`contributor/contributing` .. toctree:: :maxdepth: 2 install/index user/index - contributor/index + +.. toctree:: + :hidden: + + contributor/contributing Indices and tables ================== @@ -32,4 +37,4 @@ Indices and tables document. * `OpenStack wide search `_: Search the wider - set of OpenStack documentation, including forums. \ No newline at end of file + set of OpenStack documentation, including forums.