diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index d9012ac..4810579 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,17 +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: - http://docs.openstack.org/infra/manual/developers.html + https://opendev.org/openstack/masakari-monitors -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: +Pull requests submitted through GitHub are not monitored. - http://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/masakari-monitors + +For more specific information about contributing to this repository, see the +masakari-monitors contributor guide: + + https://docs.openstack.org/masakari-monitors/latest/contributor/contributing.html diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst deleted file mode 100644 index 1728a61..0000000 --- a/doc/source/contributing.rst +++ /dev/null @@ -1,4 +0,0 @@ -============ -Contributing -============ -.. include:: ../../CONTRIBUTING.rst diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst new file mode 100644 index 0000000..f0378b4 --- /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 `_ 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 masakari-monitors. + +Communication +~~~~~~~~~~~~~ +* IRC channel #openstack-masakari at OFTC +* Mailing list (prefix subjects with ``[masakari]`` for faster responses) + http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss + +Contacting the Core Team +~~~~~~~~~~~~~~~~~~~~~~~~ +Please refer the `masakari-monitors Core Team +`_ contacts. + +New Feature Planning +~~~~~~~~~~~~~~~~~~~~ +masakari-monitors features are tracked on `Launchpad `_. + +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 `_. + +Getting Your Patch Merged +~~~~~~~~~~~~~~~~~~~~~~~~~ +All changes proposed to the masakari-monitors project require one or two +2 votes +from masakari-monitors 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 +`_. diff --git a/doc/source/index.rst b/doc/source/index.rst index bc747ab..066c5c2 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -14,7 +14,16 @@ Contents: readme installation usage - contributing + +For Contributors +================ + +* If you are a new contributor to Masakari Monitors please refer: :doc:`contributor/contributing` + + .. toctree:: + :hidden: + + contributor/contributing Indices and tables ==================