From 48967df6d608d9f31c6c86a0f742edb597d5832c Mon Sep 17 00:00:00 2001
From: Eyal <eyal.bar-ilan@nokia.com>
Date: Thu, 23 Apr 2020 11:06:35 +0300
Subject: [PATCH] [ussuri][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: #38569

Change-Id: I3fad23a29901f38ed8350fbe631b76f69631b4a3
---
 doc/source/contributor/contributing.rst | 96 +++++++++++++++++++++++++
 doc/source/index.rst                    |  1 +
 2 files changed, 97 insertions(+)
 create mode 100644 doc/source/contributor/contributing.rst

diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst
new file mode 100644
index 000000000..176f8cd3e
--- /dev/null
+++ b/doc/source/contributor/contributing.rst
@@ -0,0 +1,96 @@
+============================
+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 Vitrage.
+
+Communication
+~~~~~~~~~~~~~
+
+* IRC channel #openstack-vitrage at FreeNode
+* Mailing list (prefix subjects with ``[vitrage]`` for faster responses)
+  http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss
+
+Contacting the Core Team
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+   * Eyal Bar-Ilan (#eyalb)
+   * Ivan Kolodyazhny (#e0ne)
+   * Idan Hefetz (#idan)
+
+New Feature Planning
+~~~~~~~~~~~~~~~~~~~~
+
+If you want to add new functionality to Vitrage please file a blueprint
+by following https://blueprints.launchpad.net/vitrage/+addspec
+
+We don't have a strict requirement to write a detailed specification for
+all new features and rather encourage more agile approach: just file a
+brief description of a feature in the form of blueprint and then send a
+patch to review (linking it to the blueprint). However, in some rare cases,
+like proposing new API, we need a spec so that the team could fully understand
+what's going to be done and provide a feedback.
+
+To file a specification for a new feature, send a patch to
+https://opendev.org/openstack/vitrage-specs that adds a new spec file
+for the needed release cycle (e.g. 'specs/victoria')
+
+The full list of the specs can be seen at
+https://specs.openstack.org/openstack/vitrage-specs/
+
+Task Tracking
+~~~~~~~~~~~~~
+We track our tasks in
+`Storyboard
+<https://storyboard.openstack.org/#!/project/openstack/vitrage>`_.
+
+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
+~~~~~~~~~~~~~~~
+If you have found an issue and want to make sure we are aware of it, please
+report the issue on
+`Storyboard
+<https://storyboard.openstack.org/#!/project/openstack/vitrage>`_.
+
+Where to Make Code Changes
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Vitrage has a number of repositories where you can make code changes:
+
+* https://github.com/openstack/vitrage
+* https://github.com/openstack/python-vitrageclient
+* https://github.com/openstack/vitrage-dashboard
+
+
+Where to Review Code Changes
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* https://review.opendev.org/#/q/vitrage
+* https://review.opendev.org/#/q/python-vitrageclient
+* https://review.opendev.org/#/q/vitrage-dashboard
+
+
+Getting Your Patch Merged
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Typically a patch can be merged when it has two +2 votes (at least two core
+members voted +2). In some rare emergency cases we allow one +2 vote before
+approving it.
+
+A patch cannot be merged if it has at least one negative vote!
+
+Project Team Lead Duties
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+All common PTL duties are enumerated in the `PTL guide
+<https://docs.openstack.org/project-team-guide/ptl.html>`_.
+
diff --git a/doc/source/index.rst b/doc/source/index.rst
index fae10f3d2..f1b1162ef 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -74,6 +74,7 @@ Developer Guide
 .. toctree::
    :maxdepth: 1
 
+   contributor/contributing
    contributor/vitrage-first_steps
    contributor/vitrage-api
    contributor/vitrage-templates