diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 0c16203..4271195 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,15 +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://opendev.org/openstack/cyborg-tempest-plugin - http://docs.openstack.org/infra/manual/developers.html +Pull requests submitted through GitHub are not monitored. -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: +To start contributing to OpenStack, follow the steps in the contribution guide +to set up and use Gerrit: - http://docs.openstack.org/infra/manual/developers.html#development-workflow + https://docs.openstack.org/contributors/code-and-documentation/quick-start.html -Pull requests submitted through GitHub will be ignored. +Bugs should be filed on Launchpad: -Bugs should be filed on Storyboardhttps://storyboard.openstack.org/#!/project/968 \ No newline at end of file + https://bugs.launchpad.net/openstack-cyborg + +For more specific information about contributing to this repository, see the +cyborg-tempest-plugin contributor guide: + + https://opendev.org/openstack/cyborg-tempest-plugin/src/branch/master/doc/source/contributor/contributing.rst diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst new file mode 100644 index 0000000..4016510 --- /dev/null +++ b/doc/source/contributor/contributing.rst @@ -0,0 +1,47 @@ +============================ +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 cyborg-tempest-plugin. + +Communication +~~~~~~~~~~~~~ +* IRC channel #openstack-cyborg at OFTC +* Mailing list (prefix subjects with ``[cyborg]`` for faster responses) + http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss + +Contacting the Core Team +~~~~~~~~~~~~~~~~~~~~~~~~ +Please refer the `cyborg-tempest-plugin Core Team +<https://review.opendev.org/admin/groups/5ecdd69a9647b2854f0effd73b98580164ab7bc9>`_ contacts. + +New Feature Planning +~~~~~~~~~~~~~~~~~~~~ +cyborg-tempest-plugin features are tracked on `Launchpad Bugs <https://bugs.launchpad.net/openstack-cyborg>`_. + +Task Tracking +~~~~~~~~~~~~~ +We track our tasks in `Launchpad Bugs <https://bugs.launchpad.net/openstack-cyborg>`_. +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 Bugs <https://bugs.launchpad.net/openstack-cyborg>`_. + +Getting Your Patch Merged +~~~~~~~~~~~~~~~~~~~~~~~~~ +All changes proposed to the cyborg-tempest-plugin project require one or two +2 votes +from cyborg-tempest-plugin core reviewers before one of the core reviewers 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>`_.