From ac68b459172d8e97b82d47cbdffc65df098d94bf Mon Sep 17 00:00:00 2001 From: Ghanshyam Mann Date: Tue, 21 Apr 2020 20:00:55 -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: I1c5e5ae8c734ab051bb889588dfd0fa908ee4ff3 --- CONTRIBUTING.rst | 19 +++++++++ doc/source/contributor/contributing.rst | 55 +++++++++++++++++++++++++ doc/source/index.rst | 9 ++++ 3 files changed, 83 insertions(+) create mode 100644 CONTRIBUTING.rst create mode 100644 doc/source/contributor/contributing.rst diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 0000000..d0488cb --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,19 @@ +The source repository for this project can be found at: + + https://opendev.org/openstack/devstack-plugin-nfs + +Pull requests submitted through GitHub are not monitored. + +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 Launchpad: + + https://bugs.launchpad.net/devstack-plugin-nfs + +For more specific information about contributing to this repository, see the +Devstack Plugin NFS contributor guide: + + https://docs.openstack.org/devstack-plugin-nfs/latest/contributor/contributing.html diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst new file mode 100644 index 0000000..24e9335 --- /dev/null +++ b/doc/source/contributor/contributing.rst @@ -0,0 +1,55 @@ +============================ +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 Devstack Plugin NFS. + +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 to the `Devstack Plugin NFS Core Team +`_ contacts. + +New Feature Planning +~~~~~~~~~~~~~~~~~~~~ +If you want to propose a new feature please read `Feature Proposal Process`_ +Devstack features are tracked on `Launchpad BP `_. + +Task Tracking +~~~~~~~~~~~~~ +We track our tasks in `Launchpad `_. + +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 Devstack Plugin NFS requires two ``Code-Review +2`` votes from +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 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/index.rst b/doc/source/index.rst index 98486d1..30bdad8 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -7,6 +7,15 @@ Welcome to Devstack Plugin NFS's documentation! readme +For Contributor +--------------- +If you are a new contributor to devstack-plugin-nfs, please refer to: :doc:`contributor/contributing` + +.. toctree:: + :hidden: + + contributor/contributing + Indices and tables ------------------