From fad3fa1416f2611bd883f3c46ddb2225f68e57e6 Mon Sep 17 00:00:00 2001 From: wanghao Date: Tue, 15 Jun 2021 10:11:51 +0800 Subject: [PATCH] [community 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 Change-Id: I4407ab803cf3dfd66ab3c5b25f8f0db85147cdc5 --- CONTRIBUTING.rst | 21 ++++++----- doc/source/contributor/contributing.rst | 47 +++++++++++++++++++++++++ doc/source/index.rst | 1 + 3 files changed, 60 insertions(+), 9 deletions(-) create mode 100644 doc/source/contributor/contributing.rst diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 066a28f4b..f172195f3 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,19 +1,22 @@ -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/zaqar -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 Launchpad, not GitHub: +Bugs should be filed on Launchpad: https://bugs.launchpad.net/zaqar +For more specific information about contributing to this repository, see the +zaqar contributor guide: + + https://docs.openstack.org/zaqar/latest/contributor/contributing.html + diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst new file mode 100644 index 000000000..43c373c1d --- /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 Zaqar. + +Communication +~~~~~~~~~~~~~ +* IRC channel #openstack-zaqar at OFTC +* Mailing list (prefix subjects with ``[zaqar]`` for faster responses) + http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss + +Contacting the Core Team +~~~~~~~~~~~~~~~~~~~~~~~~ +Please refer the `zaqar Core Team +`_ contacts. + +New Feature Planning +~~~~~~~~~~~~~~~~~~~~ +zaqar features are tracked on `Launchpad `_. + +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 `_. + +Getting Your Patch Merged +~~~~~~~~~~~~~~~~~~~~~~~~~ +All changes proposed to the zaqar project require one or two +2 votes +from zaqar 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 2e21c667e..c58d16d05 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -93,6 +93,7 @@ Contents admin/index install/index configuration/index + contributor/contributing contributor/index cli/index