Skip to content

Commit 060abe4

Browse files
author
Ghanshyam Mann
committed
[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: Ief0ff4a7f69a4ba44abd846d720630c2232d4fe0
1 parent 349e45c commit 060abe4

File tree

3 files changed

+70
-11
lines changed

3 files changed

+70
-11
lines changed

CONTRIBUTING.rst

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,19 @@
1-
If you would like to contribute to the development of OpenStack,
2-
you must follow the steps in this page:
3-
http://docs.openstack.org/infra/manual/developers.html
1+
The source repository for this project can be found at:
42

5-
Once those steps have been completed, changes to OpenStack
6-
should be submitted for review via the Gerrit tool, following
7-
the workflow documented at:
8-
http://docs.openstack.org/infra/manual/developers.html#development-workflow
3+
https://opendev.org/openstack/bashate
94

10-
Pull requests submitted through GitHub will be ignored.
5+
Pull requests submitted through GitHub are not monitored.
116

12-
Bugs should be filed on Launchpad, not GitHub:
13-
https://bugs.launchpad.net/bash8
7+
To start contributing to OpenStack, follow the steps in the contribution guide
8+
to set up and use Gerrit:
9+
10+
https://docs.openstack.org/contributors/code-and-documentation/quick-start.html
11+
12+
Bugs should be filed on Launchpad:
13+
14+
https://bugs.launchpad.net/bash8
15+
16+
For more specific information about contributing to this repository, see the
17+
Bashate contributor guide:
18+
19+
https://docs.openstack.org/bashate/latest/contributor/contributing.html
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
============================
2+
So You Want to Contribute...
3+
============================
4+
5+
For general information on contributing to OpenStack, please check out the
6+
`contributor guide <https://docs.openstack.org/contributors/>`_ to get started.
7+
It covers all the basics that are common to all OpenStack projects: the accounts
8+
you need, the basics of interacting with our Gerrit review system, how we
9+
communicate as a community, etc.
10+
11+
Below will cover the more project specific information you need to get started
12+
with Bashate.
13+
14+
Communication
15+
~~~~~~~~~~~~~
16+
* IRC channel ``#openstack-qa`` at FreeNode
17+
* Mailing list (prefix subjects with ``[qa]`` for faster responses)
18+
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss
19+
20+
Contacting the Core Team
21+
~~~~~~~~~~~~~~~~~~~~~~~~
22+
Please refer to the `Bashate Core Team
23+
<https://review.opendev.org/#/admin/groups/333,members>`_ contacts.
24+
25+
New Feature Planning
26+
~~~~~~~~~~~~~~~~~~~~
27+
If you want to propose a new feature please read `Feature Proposal Process`_
28+
29+
Task Tracking
30+
~~~~~~~~~~~~~
31+
We track our tasks in `Launchpad <https://bugs.launchpad.net/bash8>`__.
32+
33+
Reporting a Bug
34+
~~~~~~~~~~~~~~~
35+
You found an issue and want to make sure we are aware of it? You can do so on
36+
`Launchpad <https://bugs.launchpad.net/bash8/+filebug>`__.
37+
More info about Launchpad usage can be found on `OpenStack docs page
38+
<https://docs.openstack.org/contributors/common/task-tracking.html#launchpad>`_
39+
40+
Getting Your Patch Merged
41+
~~~~~~~~~~~~~~~~~~~~~~~~~
42+
All changes proposed to the Bashate requires single ``Code-Review +2`` votes as minimum from
43+
Bashate core reviewers who can approve patch by giving ``Workflow +1`` vote.
44+
45+
Project Team Lead Duties
46+
~~~~~~~~~~~~~~~~~~~~~~~~
47+
All common PTL duties are enumerated in the `PTL guide
48+
<https://docs.openstack.org/project-team-guide/ptl.html>`_.
49+
50+
The Release Process for QA is documented in `QA Release Process
51+
<https://wiki.openstack.org/wiki/QA/releases>`_.
52+
53+
.. _Feature Proposal Process: https://wiki.openstack.org/wiki/QA#Feature_Proposal_.26_Design_discussions

doc/source/contributor/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
============
22
Contributing
33
============
4-
.. include:: ../../../CONTRIBUTING.rst
4+
.. include:: ./contributing.rst

0 commit comments

Comments
 (0)