diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 07d2d256..53c75345 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,16 +1,19 @@ -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: - https://docs.openstack.org/infra/manual/developers.html + https://opendev.org/openstack/os-vif -Once those steps have been completed, changes to OpenStack -should be submitted for review via the Gerrit tool, following -the workflow documented at: +Pull requests submitted through GitHub are not monitored. - 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 + +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 diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst new file mode 100644 index 00000000..71cce6b9 --- /dev/null +++ b/doc/source/contributor/contributing.rst @@ -0,0 +1,57 @@ +============================ +So You Want to Contribute... +============================ + +For general information on contributing to OpenStack, please check out the +`contributor guide `_ 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 `_. + +Contacting the Core Team +~~~~~~~~~~~~~~~~~~~~~~~~ + +The overall structure of the os-vif team is documented on `the wiki +`_. + +New Feature Planning +~~~~~~~~~~~~~~~~~~~~ + +You can file an RFE `bug `_ 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 `__. + +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 `__. +More info about Launchpad usage can be found on `OpenStack docs page +`_. + +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. diff --git a/doc/source/index.rst b/doc/source/index.rst index ddd315b9..40616541 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -29,6 +29,16 @@ Usage Guide user/plugins/noop user/plugins/ovs +For Contributors +---------------- + +* If you are a new contributor to os-vif please refer: :doc:`contributor/contributing` + +.. toctree:: + :hidden: + + contributor/contributing + Reference ---------