Update Readme
* Add CONTRIBUTING and HACKING information files Change-Id: I7ba4936da5d1117ff170d58b06ae5e96e8bddea9
This commit is contained in:
parent
ec30a5a861
commit
33d116914c
|
@ -0,0 +1,49 @@
|
||||||
|
======================
|
||||||
|
Contributing to Murano
|
||||||
|
======================
|
||||||
|
|
||||||
|
If you're interested in contributing to the Murano project,
|
||||||
|
the following will help get you started.
|
||||||
|
|
||||||
|
Contributor License Agreement
|
||||||
|
=============================
|
||||||
|
|
||||||
|
In order to contribute to the Murano project, you need to have
|
||||||
|
signed OpenStack's contributor's agreement:
|
||||||
|
|
||||||
|
* http://docs.openstack.org/infra/manual/developers.html
|
||||||
|
* http://wiki.openstack.org/CLA
|
||||||
|
|
||||||
|
|
||||||
|
Project Hosting Details
|
||||||
|
=======================
|
||||||
|
|
||||||
|
* Bug tracker
|
||||||
|
* https://launchpad.net/murano
|
||||||
|
|
||||||
|
* https://launchpad.net/python-muranoclient
|
||||||
|
|
||||||
|
* 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://git.openstack.org/cgit/openstack/murano
|
||||||
|
|
||||||
|
* https://git.openstack.org/cgit/openstack/murano-agent
|
||||||
|
|
||||||
|
* https://git.openstack.org/cgit/openstack/murano-dashboard
|
||||||
|
|
||||||
|
* https://git.openstack.org/cgit/openstack/python-muranoclient
|
||||||
|
|
||||||
|
* Code Review
|
||||||
|
* https://review.openstack.org/#/q/murano+AND+status:+open,n,z
|
||||||
|
|
||||||
|
* http://docs.openstack.org/infra/manual/developers.html#development-workflow
|
|
@ -0,0 +1,4 @@
|
||||||
|
Style Commandments
|
||||||
|
==================
|
||||||
|
|
||||||
|
Read the OpenStack Style Commandments http://docs.openstack.org/developer/hacking/
|
41
README.rst
41
README.rst
|
@ -5,34 +5,35 @@ developers and cloud administrators to publish various cloud-ready
|
||||||
applications in a browsable categorised catalog, which may be used by the
|
applications in a browsable categorised catalog, which may be used by the
|
||||||
cloud users (including the inexperienced ones) to pick-up the needed
|
cloud users (including the inexperienced ones) to pick-up the needed
|
||||||
applications and services and composes the reliable environments out of them
|
applications and services and composes the reliable environments out of them
|
||||||
in a “push-the-button” manner.
|
in a "push-the-button" manner.
|
||||||
|
|
||||||
python-muranoclient
|
Python Muranoclient
|
||||||
-------------------
|
-------------------
|
||||||
python-muranoclient is a client library for Murano built on the Murano API.
|
python-muranoclient is a client library for Murano built on the Murano API.
|
||||||
It provides a Python API (the ``muranoclient`` module) and a command-line tool
|
It provides a Python API (the ``muranoclient`` module) and a command-line tool
|
||||||
(``murano``).
|
(``murano``).
|
||||||
|
|
||||||
|
|
||||||
Project Resources
|
Project Resources
|
||||||
-----------------
|
-----------------
|
||||||
* `Murano at Launchpad <http://launchpad.net/murano>`__
|
|
||||||
* `Wiki <https://wiki.openstack.org/wiki/Murano>`__
|
|
||||||
* `Code Review <https://review.openstack.org/>`__
|
|
||||||
* `Sources <https://wiki.openstack.org/wiki/Murano/SourceCode>`__
|
|
||||||
* `Developers Guide <http://murano-docs.github.io/latest/developers-guide/content/ch02.html>`__
|
|
||||||
|
|
||||||
How To Participate
|
Project status, bugs, and blueprints are tracked on Launchpad:
|
||||||
------------------
|
|
||||||
If you would like to ask some questions or make proposals, feel free to reach
|
|
||||||
us on #murano IRC channel at FreeNode. Typically somebody from our team will
|
|
||||||
be online at IRC from 6:00 to 20:00 UTC. You can also contact Murano community
|
|
||||||
directly by openstack-dev@lists.openstack.org adding [Murano] to a subject.
|
|
||||||
|
|
||||||
We’re holding public weekly meetings on Tuesdays at 17:00 UTC
|
* Client bug tracker
|
||||||
on #openstack-meeting-alt IRC channel at FreeNode.
|
* https://launchpad.net/python-muranoclient
|
||||||
|
|
||||||
If you want to contribute either to docs or to code, simply send us change
|
* Murano bug tracker
|
||||||
request via `gerrit <https://review.openstack.org/>`__.
|
* https://launchpad.net/murano
|
||||||
You can `file bugs <https://bugs.launchpad.net/murano/+filebug>`__ and
|
|
||||||
`register blueprints <https://blueprints.launchpad.net/murano/+addspec>`__ on
|
Developer documentation can be found here:
|
||||||
Launchpad.
|
|
||||||
|
https://murano.readthedocs.org
|
||||||
|
|
||||||
|
Additional resources are linked from the project wiki page:
|
||||||
|
|
||||||
|
https://wiki.openstack.org/wiki/Murano
|
||||||
|
|
||||||
|
License
|
||||||
|
-------
|
||||||
|
|
||||||
|
Apache License Version 2.0 http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
Loading…
Reference in New Issue