From 934a0395f70f6682585022b6422dd010e4ac9b09 Mon Sep 17 00:00:00 2001 From: Ghanshyam Mann Date: Fri, 14 May 2021 16:35:01 -0500 Subject: [PATCH] [community goal] Update contributor documentation This patch updates/adds the contributor documentation to follow the guidelines of the Ussuri cycle community goal[1]. [1] https://governance.openstack.org/tc/goals/selected/ussuri/project-ptl-and-contrib-docs.html Story: #2007236 Task: #38536 Change-Id: I604a5f433d3de88fc21befac65d8be24f0f42a44 --- CONTRIBUTING.rst | 32 ++++++----------- doc/source/contributor/contributing.rst | 47 +++++++++++++++++++++++++ doc/source/index.rst | 10 ++++++ 3 files changed, 68 insertions(+), 21 deletions(-) create mode 100644 doc/source/contributor/contributing.rst diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index a3eedf3..3225982 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,29 +1,19 @@ -Contributing -============ +The source repository for this project can be found at: -How To Get Started ------------------- + https://opendev.org/openstack/masakari-dashboard -If you would like to contribute to the development of OpenStack, you must -follow the steps in this page: +Pull requests submitted through GitHub are not monitored. - https://docs.openstack.org/infra/manual/developers.html +To start contributing to OpenStack, follow the steps in the contribution guide +to set up and use Gerrit: -Gerrit Workflow ---------------- + https://docs.openstack.org/contributors/code-and-documentation/quick-start.html -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: +Bugs should be filed on Launchpad: - https://docs.openstack.org/infra/manual/developers.html#development-workflow + https://bugs.launchpad.net/masakari -Pull requests submitted through GitHub will be ignored. +For more specific information about contributing to this repository, see the +masakari-dashboard contributor guide: -Bugs ----- - -Bugs should be filed on Launchpad, not GitHub: - - https://bugs.launchpad.net/masakari + https://docs.openstack.org/masakari-dashboard/latest/contributor/contributing.html diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst new file mode 100644 index 0000000..33b2521 --- /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-dashboard. + +Communication +~~~~~~~~~~~~~ +* IRC channel #openstack-masakari at FreeNode +* 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-dashboard Core Team +`_ contacts. + +New Feature Planning +~~~~~~~~~~~~~~~~~~~~ +masakari-dashboard 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-dashboard project require one or two +2 votes +from masakari-dashboard 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 66e63fa..4ba5405 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -63,3 +63,13 @@ To run horizon with the newly enabled Masakari dashboard plugin run:: to have the application start on port 8080 and the horizon dashboard will be available in your browser at http://localhost:8080/ + +For Contributors +================ + +* If you are a new contributor to Masakari Dashboard please refer: :doc:`contributor/contributing` + + .. toctree:: + :hidden: + + contributor/contributing