From bb65fc64026d431ffb866d02825deb3a0e4b5943 Mon Sep 17 00:00:00 2001 From: Ghanshyam Mann Date: Mon, 17 May 2021 18:22:04 -0500 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 Story: #2007236 Task: #38539 Change-Id: I12ddfc0d4332ea19b5b0abab5cac61653726e3d1 --- CONTRIBUTING.rst | 23 ++++++------ doc/source/contributing.rst | 4 --- doc/source/contributor/contributing.rst | 47 +++++++++++++++++++++++++ doc/source/index.rst | 8 +++-- 4 files changed, 66 insertions(+), 16 deletions(-) delete mode 100644 doc/source/contributing.rst create mode 100644 doc/source/contributor/contributing.rst diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 13b27f5..9b61731 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: - http://docs.openstack.org/infra/manual/developers.html + https://opendev.org/openstack/yaql -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. - http://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/yaql \ No newline at end of file + https://bugs.launchpad.net/yaql + +For more specific information about contributing to this repository, see the +yaql contributor guide: + + https://docs.openstack.org/yaql/latest/contributor/contributing.html diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst deleted file mode 100644 index ed77c12..0000000 --- a/doc/source/contributing.rst +++ /dev/null @@ -1,4 +0,0 @@ -============ -Contributing -============ -.. include:: ../../CONTRIBUTING.rst \ No newline at end of file diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst new file mode 100644 index 0000000..0de1130 --- /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 yaql. + +Communication +~~~~~~~~~~~~~ +* IRC channel #murano at OFTC +* Mailing list (prefix subjects with ``[murano]`` for faster responses) + http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss + +Contacting the Core Team +~~~~~~~~~~~~~~~~~~~~~~~~ +Please refer the `yaql Core Team +`_ contacts. + +New Feature Planning +~~~~~~~~~~~~~~~~~~~~ +yaql 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 yaql project require one or two +2 votes +from yaql 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 a7e5c73..e4ad677 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -24,8 +24,12 @@ Welcome to yaql documentation! standard_library -.. toctree:: +For Contributors +================ - contributing +* If you are a new contributor to Yaql please refer: :doc:`contributor/contributing` + .. toctree:: + :hidden: + contributor/contributing