From c910a107c868ba44b5f6ffff53b9f6074e944b9a Mon Sep 17 00:00:00 2001 From: Dmitriy Rabotyagov Date: Tue, 12 May 2020 22:38:49 +0300 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: If8017854d98fb0fc071d6afe23f6111da25aa8e4 --- CONTRIBUTING.rst | 88 ++++++------------------------------------------ 1 file changed, 11 insertions(+), 77 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 34911f6b..aa200943 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,85 +1,19 @@ -os_nova -####### -:tags: openstack, cloud, ansible -:category: \*nix +The source repository for this project can be found at: -contributor guidelines -^^^^^^^^^^^^^^^^^^^^^^ + https://opendev.org/openstack/openstack-ansible-os_nova -Filing Bugs ------------ +Pull requests submitted through GitHub are not monitored. -Bugs should be filed on Launchpad, not GitHub: "https://bugs.launchpad.net/openstack-ansible" +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 -When submitting a bug, or working on a bug, please ensure the following criteria are met: - * The description clearly states or describes the original problem or root cause of the problem. - * Include historical information on how the problem was identified. - * Any relevant logs are included. - * The provided information should be totally self-contained. External access to web services/sites should not be needed. - * Steps to reproduce the problem if possible. +Bugs should be filed on Launchpad: + https://bugs.launchpad.net/openstack-ansible -Submitting Code ---------------- +For more specific information about contributing to this repository, see the +openstack-ansible contributor guide: -Changes to the project should be submitted for review via the Gerrit tool, following -the workflow documented at: "http://docs.openstack.org/infra/manual/developers.html#development-workflow" - -Pull requests submitted through GitHub will be ignored and closed without regard. - - -Extra ------ - -Tags: - If it's a bug that needs fixing in a branch in addition to Master, add a '\-backport-potential' tag (eg ``juno-backport-potential``). There are predefined tags that will autocomplete. - -Status: - Please leave this alone, it should be New till someone triages the issue. - -Importance: - Should only be touched if it is a Blocker/Gating issue. If it is, please set to High, and only use Critical if you have found a bug that can take down whole infrastructures. - - -Style guide ------------ - -When creating tasks and other roles for use in Ansible please create then using the YAML dictionary format. - -Example YAML dictionary format: - .. code-block:: yaml - - - name: The name of the tasks - module_name: - thing1: "some-stuff" - thing2: "some-other-stuff" - tags: - - some-tag - - some-other-tag - - -Example **NOT** in YAML dictionary format: - .. code-block:: yaml - - - name: The name of the tasks - module_name: thing1="some-stuff" thing2="some-other-stuff" - tags: - - some-tag - - some-other-tag - - -Usage of the ">" and "|" operators should be limited to Ansible conditionals and command modules such as the ansible ``shell`` module. - - -Issues ------- - -When submitting an issue, or working on an issue please ensure the following criteria are met: - * The description clearly states or describes the original problem or root cause of the problem. - * Include historical information on how the problem was identified. - * Any relevant logs are included. - * If the issue is a bug that needs fixing in a branch other than Master, add the 'backport potential' tag TO THE ISSUE (not the PR). - * The provided information should be totally self-contained. External access to web services/sites should not be needed. - * If the issue is needed for a hotfix release, add the 'expedite' label. - * Steps to reproduce the problem if possible. + https://docs.openstack.org/openstack-ansible/latest/contributor/contributing.html