[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: I11f746df8ddfba5cf0b1e33778c9939a0a5fc760
This commit is contained in:
		@@ -1,19 +1,19 @@
 | 
			
		||||
Contributing
 | 
			
		||||
============
 | 
			
		||||
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/stackviz
 | 
			
		||||
 | 
			
		||||
If you already have a good understanding of how the system works and your
 | 
			
		||||
OpenStack accounts are set up, you can skip to the development workflow
 | 
			
		||||
section of this documentation to learn how changes to OpenStack should be
 | 
			
		||||
submitted for review via the Gerrit tool:
 | 
			
		||||
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/stackviz
 | 
			
		||||
   https://bugs.launchpad.net/tempest (We use Tempest Launchpad for Stackviz bugs tracking.)
 | 
			
		||||
 | 
			
		||||
For more specific information about contributing to this repository, see the
 | 
			
		||||
Stackviz contributor guide:
 | 
			
		||||
 | 
			
		||||
   https://docs.openstack.org/stackviz/latest/contributor/contributing.html
 | 
			
		||||
 
 | 
			
		||||
@@ -1 +0,0 @@
 | 
			
		||||
.. include:: ../../CONTRIBUTING.rst
 | 
			
		||||
							
								
								
									
										55
									
								
								doc/source/contributor/contributing.rst
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										55
									
								
								doc/source/contributor/contributing.rst
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,55 @@
 | 
			
		||||
============================
 | 
			
		||||
So You Want to Contribute...
 | 
			
		||||
============================
 | 
			
		||||
 | 
			
		||||
For general information on contributing to OpenStack, please check out the
 | 
			
		||||
`contributor guide <https://docs.openstack.org/contributors/>`_ 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 Stackviz.
 | 
			
		||||
 | 
			
		||||
Communication
 | 
			
		||||
~~~~~~~~~~~~~
 | 
			
		||||
* IRC channel ``#openstack-qa`` at FreeNode
 | 
			
		||||
* Mailing list (prefix subjects with ``[qa]`` for faster responses)
 | 
			
		||||
  http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss
 | 
			
		||||
 | 
			
		||||
Contacting the Core Team
 | 
			
		||||
~~~~~~~~~~~~~~~~~~~~~~~~
 | 
			
		||||
Please refer to the `Stackviz Core Team
 | 
			
		||||
<https://review.opendev.org/#/admin/groups/1072,members>`_ contacts.
 | 
			
		||||
 | 
			
		||||
New Feature Planning
 | 
			
		||||
~~~~~~~~~~~~~~~~~~~~
 | 
			
		||||
If you want to propose a new feature please read `Feature Proposal Process`_
 | 
			
		||||
 | 
			
		||||
Task Tracking
 | 
			
		||||
~~~~~~~~~~~~~
 | 
			
		||||
There is no separate task tracking tool for Stackviz, we track our tasks in
 | 
			
		||||
`Launchpad <https://bugs.launchpad.net/tempest>`__.
 | 
			
		||||
 | 
			
		||||
Reporting a Bug
 | 
			
		||||
~~~~~~~~~~~~~~~
 | 
			
		||||
You found an issue and want to make sure we are aware of it? You can do so on
 | 
			
		||||
`Launchpad <https://bugs.launchpad.net/tempest/+filebug>`__. There is no separate
 | 
			
		||||
Launchpad for Stackviz.
 | 
			
		||||
More info about Launchpad usage can be found on `OpenStack docs page
 | 
			
		||||
<https://docs.openstack.org/contributors/common/task-tracking.html#launchpad>`_
 | 
			
		||||
 | 
			
		||||
Getting Your Patch Merged
 | 
			
		||||
~~~~~~~~~~~~~~~~~~~~~~~~~
 | 
			
		||||
All changes proposed to the Stackviz requires single ``Code-Review +2`` votes as minimum from
 | 
			
		||||
Stackviz core reviewers who can approve patch by giving ``Workflow +1`` vote.
 | 
			
		||||
 | 
			
		||||
Project Team Lead Duties
 | 
			
		||||
~~~~~~~~~~~~~~~~~~~~~~~~
 | 
			
		||||
All common PTL duties are enumerated in the `PTL guide
 | 
			
		||||
<https://docs.openstack.org/project-team-guide/ptl.html>`_.
 | 
			
		||||
 | 
			
		||||
The Release Process for QA is documented in `QA Release Process
 | 
			
		||||
<https://wiki.openstack.org/wiki/QA/releases>`_.
 | 
			
		||||
 | 
			
		||||
.. _Feature Proposal Process: https://wiki.openstack.org/wiki/QA#Feature_Proposal_.26_Design_discussions
 | 
			
		||||
@@ -19,7 +19,15 @@ Local Stackviz
 | 
			
		||||
   readme
 | 
			
		||||
   installation
 | 
			
		||||
   usage
 | 
			
		||||
   contributing
 | 
			
		||||
 | 
			
		||||
For Contributor
 | 
			
		||||
---------------
 | 
			
		||||
If you are a new contributor to Stackviz please refer: :doc:`contributor/contributing`
 | 
			
		||||
 | 
			
		||||
.. toctree::
 | 
			
		||||
   :hidden:
 | 
			
		||||
 | 
			
		||||
   contributor/contributing
 | 
			
		||||
 | 
			
		||||
Manual Pages
 | 
			
		||||
------------
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user