Browse code
[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: I870955fda7ee6e0d7809faa309bbc31c2ddd653a
Ghanshyam Mann authored on 2020/04/20 07:54:56Showing 3 changed files
| 1 | 1 |
new file mode 100644 |
| ... | ... |
@@ -0,0 +1,19 @@ |
| 0 |
+The source repository for this project can be found at: |
|
| 1 |
+ |
|
| 2 |
+ https://opendev.org/openstack/devstack |
|
| 3 |
+ |
|
| 4 |
+Pull requests submitted through GitHub are not monitored. |
|
| 5 |
+ |
|
| 6 |
+To start contributing to OpenStack, follow the steps in the contribution guide |
|
| 7 |
+to set up and use Gerrit: |
|
| 8 |
+ |
|
| 9 |
+ https://docs.openstack.org/contributors/code-and-documentation/quick-start.html |
|
| 10 |
+ |
|
| 11 |
+Bugs should be filed on Launchpad: |
|
| 12 |
+ |
|
| 13 |
+ https://bugs.launchpad.net/devstack |
|
| 14 |
+ |
|
| 15 |
+For more specific information about contributing to this repository, see the |
|
| 16 |
+Devstack contributor guide: |
|
| 17 |
+ |
|
| 18 |
+ https://docs.openstack.org/devstack/latest/contributor/contributing.html |
| 0 | 19 |
new file mode 100644 |
| ... | ... |
@@ -0,0 +1,56 @@ |
| 0 |
+============================ |
|
| 1 |
+So You Want to Contribute... |
|
| 2 |
+============================ |
|
| 3 |
+ |
|
| 4 |
+For general information on contributing to OpenStack, please check out the |
|
| 5 |
+`contributor guide <https://docs.openstack.org/contributors/>`_ to get started. |
|
| 6 |
+It covers all the basics that are common to all OpenStack projects: the accounts |
|
| 7 |
+you need, the basics of interacting with our Gerrit review system, how we |
|
| 8 |
+communicate as a community, etc. |
|
| 9 |
+ |
|
| 10 |
+Below will cover the more project specific information you need to get started |
|
| 11 |
+with Devstack. |
|
| 12 |
+ |
|
| 13 |
+Communication |
|
| 14 |
+~~~~~~~~~~~~~ |
|
| 15 |
+* IRC channel ``#openstack-qa`` at FreeNode |
|
| 16 |
+* Mailing list (prefix subjects with ``[qa][devstack]`` for faster responses) |
|
| 17 |
+ http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss |
|
| 18 |
+ |
|
| 19 |
+Contacting the Core Team |
|
| 20 |
+~~~~~~~~~~~~~~~~~~~~~~~~ |
|
| 21 |
+Please refer to the `Devstack Core Team |
|
| 22 |
+<https://review.opendev.org/#/admin/groups/50,members>`_ contacts. |
|
| 23 |
+ |
|
| 24 |
+New Feature Planning |
|
| 25 |
+~~~~~~~~~~~~~~~~~~~~ |
|
| 26 |
+If you want to propose a new feature please read `Feature Proposal Process`_ |
|
| 27 |
+Devstack features are tracked on `Launchpad BP <https://blueprints.launchpad.net/devstack>`_. |
|
| 28 |
+ |
|
| 29 |
+Task Tracking |
|
| 30 |
+~~~~~~~~~~~~~ |
|
| 31 |
+We track our tasks in `Launchpad <https://bugs.launchpad.net/devstack>`_. |
|
| 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/devstack/+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 Devstack require two ``Code-Review +2`` votes from |
|
| 43 |
+Devstack core reviewers before one of the core reviewers can approve the patch |
|
| 44 |
+by giving ``Workflow +1`` vote. One exception is for patches to unblock the gate |
|
| 45 |
+which can be approved by single core reviewers. |
|
| 46 |
+ |
|
| 47 |
+Project Team Lead Duties |
|
| 48 |
+~~~~~~~~~~~~~~~~~~~~~~~~ |
|
| 49 |
+All common PTL duties are enumerated in the `PTL guide |
|
| 50 |
+<https://docs.openstack.org/project-team-guide/ptl.html>`_. |
|
| 51 |
+ |
|
| 52 |
+The Release Process for QA is documented in `QA Release Process |
|
| 53 |
+<https://wiki.openstack.org/wiki/QA/releases>`_. |
|
| 54 |
+ |
|
| 55 |
+.. _Feature Proposal Process: https://wiki.openstack.org/wiki/QA#Feature_Proposal_.26_Design_discussions |
| ... | ... |
@@ -151,6 +151,13 @@ Get :doc:`the big picture <overview>` of what we are trying to do |
| 151 | 151 |
with devstack, and help us by :doc:`contributing to the project |
| 152 | 152 |
<hacking>`. |
| 153 | 153 |
|
| 154 |
+If you are a new contributor to devstack please refer: :doc:`contributor/contributing` |
|
| 155 |
+ |
|
| 156 |
+.. toctree:: |
|
| 157 |
+ :hidden: |
|
| 158 |
+ |
|
| 159 |
+ contributor/contributing |
|
| 160 |
+ |
|
| 154 | 161 |
Contents |
| 155 | 162 |
++++++++ |
| 156 | 163 |
|