diff options
| -rw-r--r-- | CONTRIBUTING.rst | 21 | ||||
| -rw-r--r-- | doc/source/contributor/contributing.rst | 52 | ||||
| -rw-r--r-- | doc/source/contributor/index.rst | 14 |
3 files changed, 72 insertions, 15 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 20115405..d4205aed 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 documented at: +The source repository for this project can be found at: - https://docs.openstack.org/infra/manual/developers.html#development-workflow + https://opendev.org/openstack/python-novaclient -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/python-novaclient + +For more specific information about contributing to this repository, see the +python-novaclient contributor guide: + + https://docs.openstack.org/python-novaclient/latest/contributor/contributing.html diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst new file mode 100644 index 00000000..38eac4ec --- /dev/null +++ b/doc/source/contributor/contributing.rst @@ -0,0 +1,52 @@ +============================ +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 python-novaclient. + +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 Nova team including python-novaclient is +documented on `the wiki <https://wiki.openstack.org/wiki/Nova#People>`_. + +New Feature Planning +~~~~~~~~~~~~~~~~~~~~ + +If you want to propose a new feature please read the +`blueprints <https://docs.openstack.org/nova/latest/contributor/blueprints.html>`_ page. + +Task Tracking +~~~~~~~~~~~~~ + +We track our tasks in `Launchpad <https://bugs.launchpad.net/python-novaclient>`__. + +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/python-novaclient/+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 python-novaclient requires two ``Code-Review +2`` +votes from python-novaclient core reviewers before one of the core reviewers +can approve patch by giving ``Workflow +1`` vote.. diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst index 50fd507f..b52cfce6 100644 --- a/doc/source/contributor/index.rst +++ b/doc/source/contributor/index.rst @@ -2,14 +2,16 @@ Contributor Guide =================== -Code is hosted at `opendev.org`__. Submit bugs to the python-novaclient -project on `Launchpad`__. Submit code to the `openstack/python-novaclient` -project using `Gerrit`__. +Basic Information +================= -__ https://opendev.org/openstack/python-novaclient -__ https://bugs.launchpad.net/python-novaclient -__ https://docs.openstack.org/infra/manual/developers.html#development-workflow +.. toctree:: + :maxdepth: 2 + + contributing +Developer Guide +=============== .. toctree:: :maxdepth: 2 |