[ussuri][goal] Add project specific contributor docs
* This patch adds more content to the contributor docs as described at https://governance.openstack.org/tc/goals/selected/ussuri/project-ptl-and-contrib-docs.html Change-Id: I6eea5db63070bd60fe2475f1fd34e43f855f6aa2
This commit is contained in:
Renat Akhmerov
parent
a7da00d7e4
commit
c90472d3e6
@ -1,66 +1,19 @@
|
||||
=======================
|
||||
Contributing to Mistral
|
||||
=======================
|
||||
The source repository for this project can be found at:
|
||||
|
||||
If you're interested in contributing to the Mistral project,
|
||||
the following will help get you started.
|
||||
https://opendev.org/openstack/mistral
|
||||
|
||||
Contributor License Agreement
|
||||
=============================
|
||||
Pull requests submitted through GitHub are not monitored.
|
||||
|
||||
In order to contribute to the Mistral project, you need to have
|
||||
signed OpenStack's contributor's agreement:
|
||||
To start contributing to OpenStack, follow the steps in the contribution guide
|
||||
to set up and use Gerrit:
|
||||
|
||||
* https://docs.openstack.org/infra/manual/developers.html
|
||||
* https://wiki.openstack.org/CLA
|
||||
https://docs.openstack.org/contributors/code-and-documentation/quick-start.html
|
||||
|
||||
Bugs should be filed on Launchpad:
|
||||
|
||||
Project Hosting Details
|
||||
=======================
|
||||
https://bugs.launchpad.net/mistral
|
||||
|
||||
* Bug trackers
|
||||
* General mistral tracker: https://launchpad.net/mistral
|
||||
For more specific information about contributing to this repository, see the
|
||||
Mistral contributor guide:
|
||||
|
||||
* Python client tracker: https://launchpad.net/python-mistralclient
|
||||
|
||||
* Mailing list (prefix subjects with ``[Mistral]`` for faster responses)
|
||||
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss
|
||||
|
||||
* Documentation
|
||||
* https://docs.openstack.org/mistral/latest/
|
||||
|
||||
* IRC channel
|
||||
* #openstack-mistral at FreeNode
|
||||
|
||||
* https://wiki.openstack.org/wiki/Mistral/Meetings_Meetings
|
||||
|
||||
* Code Hosting
|
||||
* https://github.com/openstack/mistral
|
||||
|
||||
* https://github.com/openstack/python-mistralclient
|
||||
|
||||
* https://github.com/openstack/mistral-dashboard
|
||||
|
||||
* https://github.com/openstack/mistral-lib
|
||||
|
||||
* https://github.com/openstack/mistral-specs
|
||||
|
||||
* https://github.com/openstack/mistral-specs
|
||||
|
||||
* Code Review
|
||||
* https://review.opendev.org/#/q/mistral
|
||||
|
||||
* https://review.opendev.org/#/q/python-mistralclient
|
||||
|
||||
* https://review.opendev.org/#/q/mistral-dashboard
|
||||
|
||||
* https://review.opendev.org/#/q/mistral-lib
|
||||
|
||||
* https://review.opendev.org/#/q/mistral-extra
|
||||
|
||||
* https://review.opendev.org/#/q/mistral-specs
|
||||
|
||||
* https://docs.openstack.org/infra/manual/developers.html#development-workflow
|
||||
|
||||
* Mistral Design Specifications
|
||||
* https://specs.openstack.org/openstack/mistral-specs/
|
||||
https://docs.openstack.org/mistral/latest/contributor/contributing.html
|
||||
|
||||
9
doc/source/contributor/contributing.rst
Normal file
9
doc/source/contributor/contributing.rst
Normal file
@ -0,0 +1,9 @@
|
||||
.. This file exist only because there's a requirement to have the file
|
||||
'contributing.rst' under the folder 'doc/source/contributor' according
|
||||
to https://governance.openstack.org/tc/goals/selected/ussuri/project-ptl-and-contrib-docs.html#completion-criteria
|
||||
It generally conflicts with the approach taken in Mistral to divide
|
||||
all the docs into the three main categories: admin, developer, and user.
|
||||
So to avoid duplicating the content of the file we just use a directive
|
||||
for inclusion.
|
||||
|
||||
.. include:: ../developer/contributor/contributing.rst
|
||||
101
doc/source/developer/contributor/contributing.rst
Normal file
101
doc/source/developer/contributor/contributing.rst
Normal file
@ -0,0 +1,101 @@
|
||||
============================
|
||||
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 Mistral.
|
||||
|
||||
Communication
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
* IRC channel #openstack-mistral at FreeNode
|
||||
* Mailing list (prefix subjects with ``[mistral]`` for faster responses)
|
||||
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss
|
||||
|
||||
Contacting the Core Team
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
* Renat Akhmerov, PTL (#rakhmerov)
|
||||
* Eyal Bar-Ilan (#eyalb)
|
||||
* Oleg Ovcharuk (#vgvoleg)
|
||||
* Andras Kovi (#akovi)
|
||||
* Adriano Petrich (#apetrich)
|
||||
|
||||
New Feature Planning
|
||||
~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
If you want to add new functionality to Mistral please file a blueprint
|
||||
by following https://blueprints.launchpad.net/mistral/+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 or workflow language additions, 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/mistral-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/mistral-specs/
|
||||
|
||||
Task Tracking
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
We track our tasks in Launchpad: https://bugs.launchpad.net/mistral
|
||||
|
||||
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 <https://bugs.launchpad.net/mistral>`_.
|
||||
|
||||
Where to Make Code Changes
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Mistral has a number of repositories where you can make code changes:
|
||||
|
||||
* https://github.com/openstack/mistral
|
||||
* https://github.com/openstack/python-mistralclient
|
||||
* https://github.com/openstack/mistral-dashboard
|
||||
* https://github.com/openstack/mistral-extra
|
||||
* https://github.com/openstack/mistral-lib
|
||||
* https://github.com/openstack/mistral-specs
|
||||
|
||||
Where to Review Code Changes
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
* https://review.opendev.org/#/q/mistral
|
||||
* https://review.opendev.org/#/q/python-mistralclient
|
||||
* https://review.opendev.org/#/q/mistral-dashboard
|
||||
* https://review.opendev.org/#/q/mistral-extra
|
||||
* https://review.opendev.org/#/q/mistral-lib
|
||||
* https://review.opendev.org/#/q/mistral-specs
|
||||
|
||||
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>`_.
|
||||
|
||||
@ -5,6 +5,7 @@ Contributor Documentation
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
|
||||
contributing
|
||||
coding_guidelines
|
||||
debugging_and_testing
|
||||
profiling
|
||||
|
||||
@ -83,6 +83,11 @@ Main Chapters
|
||||
admin/index
|
||||
developer/index
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
contributor/contributing
|
||||
|
||||
.. only:: html
|
||||
|
||||
Search
|
||||
|
||||
Loading…
Reference in New Issue
Block a user