Browse Source

[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
changes/25/727425/2
Dmitriy Rabotyagov 2 years ago
parent
commit
9869990194
  1. 104
      CONTRIBUTING.rst
  2. 1
      doc/source/contributor/contributing.rst
  3. 8
      doc/source/contributor/index.rst
  4. 1
      doc/source/index.rst

104
CONTRIBUTING.rst

@ -1,101 +1,19 @@
Contributor Guide
=================
The source repository for this project can be found at:
:tags: openstack, cloud, ansible, os_tempest
:category: \*nix
https://opendev.org/openstack/openstack-ansible-os_tempest
Filing Bugs
-----------
Pull requests submitted through GitHub are not monitored.
Bugs should be filed or Launchpad_, **not GitHub.**
To start contributing to OpenStack, follow the steps in the contribution guide
to set up and use Gerrit:
.. _Launchpad: https://bugs.launchpad.net/openstack-ansible
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:
Bugs should be filed on Launchpad:
* 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.
https://bugs.launchpad.net/openstack-ansible
For more specific information about contributing to this repository, see the
openstack-ansible contributor guide:
Submitting Code
---------------
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
'\<release\>-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

1
doc/source/contributor/contributing.rst

@ -1 +0,0 @@
../../../CONTRIBUTING.rst

8
doc/source/contributor/index.rst

@ -1,8 +0,0 @@
Contributor Guide
=================
.. toctree::
:maxdepth: 2
:includehidden:
contributing

1
doc/source/index.rst

@ -15,7 +15,6 @@ Content:
overview
user/index
contributor/index
* :ref:`search`

Loading…
Cancel
Save