[Community goal] Update contributor documentation

As the Ussuri goal we have an OpenStack project wide contributing
documentation template [1]. os-vif use its own bug or feature
tracking LP and core team is also not exactly same as nova so adding
its own contributor guide with keeping common links from nova
with os-vif specific information.

Also the top level CONTRIBUTING.rst template has been changed in the
cookiecutter repo[2]. So this patch updates the CONTRIBUTING.rst according
to the new template.

[1] https://opendev.org/openstack/cookiecutter/src/branch/master/%7b%7bcookiecutter.repo_name%7d%7d/$
[2] https://review.opendev.org/#/c/696001

Change-Id: I6017fdbb403d4cd90f4c3c2bd4a197dfbb67f6ec
Story: #2007236
Task: #38541
This commit is contained in:
Ghanshyam Mann 2020-04-23 10:51:43 -05:00
parent 840df14b56
commit 725d430d5d
3 changed files with 79 additions and 9 deletions

View File

@ -1,16 +1,19 @@
If you would like to contribute to the development of OpenStack, The source repository for this project can be found at:
you must follow the steps in this page:
https://docs.openstack.org/infra/manual/developers.html https://opendev.org/openstack/os-vif
Once those steps have been completed, changes to OpenStack Pull requests submitted through GitHub are not monitored.
should be submitted for review via the Gerrit tool, following
the workflow documented at:
https://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/os-vif https://bugs.launchpad.net/os-vif
For more specific information about contributing to this repository, see the
os-vif contributor guide:
https://docs.openstack.org/os-vif/latest/contributor/contributing.html

View File

@ -0,0 +1,57 @@
============================
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 os-vif.
Communication
~~~~~~~~~~~~~
Please refer `how-to-get-involved <https://docs.openstack.org/nova/latest/contributor/how-to-get-involved.html>`_.
Contacting the Core Team
~~~~~~~~~~~~~~~~~~~~~~~~
The overall structure of the os-vif team is documented on `the wiki
<https://wiki.openstack.org/wiki/Nova#People>`_.
New Feature Planning
~~~~~~~~~~~~~~~~~~~~
You can file an RFE `bug <https://bugs.launchpad.net/os-vif/+filebug>`_ if it
has no interaction with other projects like nova or neutron.
If changes are part of the nova or neutron feature then it can be tracked
as part of the nova or neutron feature. In that case, you should use the
same topic to track the os-vif changes.
Task Tracking
~~~~~~~~~~~~~
We track our tasks in `Launchpad <https://bugs.launchpad.net/os-vif>`__.
If you're looking for some smaller, easier work item to pick up and get started
on, search for the 'low-hanging-fruit' tag.
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/os-vif/+filebug>`__.
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 os-vif requires two ``Code-Review +2`` votes from
os-vif core reviewers before one of the core reviewers can approve patch by
giving ``Workflow +1`` vote. One exception is for trivial changes for example
typo fixes etc which can be approved by a single core.

View File

@ -29,6 +29,16 @@ Usage Guide
user/plugins/noop user/plugins/noop
user/plugins/ovs user/plugins/ovs
For Contributors
----------------
* If you are a new contributor to os-vif please refer: :doc:`contributor/contributing`
.. toctree::
:hidden:
contributor/contributing
Reference Reference
--------- ---------