[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: #38539 Change-Id: I5425f96ef4a8817d493cfd583bb0ae2c9520f866
This commit is contained in:
Ghanshyam Mann
Ghanshyam
parent
d36954704d
commit
70dc64e7c5
|
|
@ -1,54 +1,19 @@
|
|||
======================
|
||||
Contributing to Murano
|
||||
======================
|
||||
The source repository for this project can be found at:
|
||||
|
||||
If you're interested in contributing to the Murano project,
|
||||
the following will help get you started.
|
||||
https://opendev.org/openstack/murano
|
||||
|
||||
Contributor License Agreement
|
||||
=============================
|
||||
Pull requests submitted through GitHub are not monitored.
|
||||
|
||||
In order to contribute to the Murano 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/wiki/How_To_Contribute#Contributor_License_Agreement
|
||||
https://docs.openstack.org/contributors/code-and-documentation/quick-start.html
|
||||
|
||||
Bugs should be filed on Launchpad:
|
||||
|
||||
Project Hosting Details
|
||||
=======================
|
||||
https://bugs.launchpad.net/murano
|
||||
|
||||
* Bug trackers
|
||||
* General murano tracker: https://launchpad.net/murano
|
||||
For more specific information about contributing to this repository, see the
|
||||
murano contributor guide:
|
||||
|
||||
* Python client tracker: https://launchpad.net/python-muranoclient
|
||||
|
||||
* Tracker for bugs related to specific apps: https://launchpad.net/murano-apps
|
||||
|
||||
* Mailing list (prefix subjects with ``[Murano]`` for faster responses)
|
||||
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
|
||||
|
||||
* Wiki
|
||||
https://wiki.openstack.org/wiki/Murano
|
||||
|
||||
* IRC channel
|
||||
* #murano at FreeNode
|
||||
|
||||
* https://wiki.openstack.org/wiki/Meetings#Murano_meeting
|
||||
|
||||
* Code Hosting
|
||||
* https://opendev.org/openstack/murano
|
||||
|
||||
* https://opendev.org/openstack/murano-agent
|
||||
|
||||
* https://opendev.org/openstack/murano-dashboard
|
||||
|
||||
* https://opendev.org/openstack/python-muranoclient
|
||||
|
||||
* Code Review
|
||||
* https://review.opendev.org/#/q/murano+AND+status:+open,n,z
|
||||
|
||||
* https://docs.openstack.org/infra/manual/developers.html#development-workflow
|
||||
|
||||
* Murano Design Specifications
|
||||
* https://opendev.org/openstack/murano-specs
|
||||
https://docs.openstack.org/murano/latest/contributor/contributing.html
|
||||
|
|
|
|||
|
|
@ -0,0 +1,47 @@
|
|||
============================
|
||||
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 Murano.
|
||||
|
||||
Communication
|
||||
~~~~~~~~~~~~~
|
||||
* IRC channel #murano at OFTC
|
||||
* Mailing list (prefix subjects with ``[murano]`` for faster responses)
|
||||
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss
|
||||
|
||||
Contacting the Core Team
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Please refer the `murano Core Team
|
||||
<https://review.opendev.org/admin/groups/b082df89771ed409e9ce06fd9487aefd9e4fc868,members>`_ contacts.
|
||||
|
||||
New Feature Planning
|
||||
~~~~~~~~~~~~~~~~~~~~
|
||||
murano features are tracked on `Launchpad <https://bugs.launchpad.net/murano>`_.
|
||||
|
||||
Task Tracking
|
||||
~~~~~~~~~~~~~
|
||||
We track our tasks in `Launchpad <https://bugs.launchpad.net/murano>`_.
|
||||
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/murano>`_.
|
||||
|
||||
Getting Your Patch Merged
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
All changes proposed to the murano project require one or two +2 votes
|
||||
from murano 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
|
||||
<https://docs.openstack.org/project-team-guide/ptl.html>`_.
|
||||
|
|
@ -111,11 +111,12 @@ Murano.
|
|||
Contributor Documentation
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Learn how to contribute to the project.
|
||||
* If you are a new contributor to Murano please refer: :doc:`contributor/contributing`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
contributor/contributing
|
||||
contributor/contributor_index
|
||||
|
||||
Other Documentation
|
||||
|
|
|
|||
Loading…
Reference in New Issue