diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index d662752..f877610 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,13 +1,19 @@ -If you would like to contribute to the development of OpenStack, -you must follow the steps in this page: -http://docs.openstack.org/infra/manual/developers.html +The source repository for this project can be found at: -Once those steps have been completed, changes to OpenStack -should be submitted for review via the Gerrit tool, following -the workflow documented at: -http://docs.openstack.org/infra/manual/developers.html#development-workflow + https://opendev.org/openstack/bashate -Pull requests submitted through GitHub will be ignored. +Pull requests submitted through GitHub are not monitored. -Bugs should be filed on Launchpad, not GitHub: -https://bugs.launchpad.net/bash8 +To start contributing to OpenStack, follow the steps in the contribution guide +to set up and use Gerrit: + + https://docs.openstack.org/contributors/code-and-documentation/quick-start.html + +Bugs should be filed on Launchpad: + + https://bugs.launchpad.net/bash8 + +For more specific information about contributing to this repository, see the +Bashate contributor guide: + + https://docs.openstack.org/bashate/latest/contributor/contributing.html diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst new file mode 100644 index 0000000..e37ae3e --- /dev/null +++ b/doc/source/contributor/contributing.rst @@ -0,0 +1,53 @@ +============================ +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 Bashate. + +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 `Bashate Core Team +`_ contacts. + +New Feature Planning +~~~~~~~~~~~~~~~~~~~~ +If you want to propose a new feature please read `Feature Proposal Process`_ + +Task Tracking +~~~~~~~~~~~~~ +We track our tasks in `Launchpad `__. + +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 Bashate requires single ``Code-Review +2`` votes as minimum from +Bashate 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 +`_. + +The Release Process for QA is documented in `QA Release Process +`_. + +.. _Feature Proposal Process: https://wiki.openstack.org/wiki/QA#Feature_Proposal_.26_Design_discussions diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst index 2aa0707..3d1d36d 100644 --- a/doc/source/contributor/index.rst +++ b/doc/source/contributor/index.rst @@ -1,4 +1,4 @@ ============ Contributing ============ -.. include:: ../../../CONTRIBUTING.rst +.. include:: ./contributing.rst