diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 5414a916..ebf88e6c 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,51 +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-apps -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: -* http://docs.openstack.org/infra/manual/developers.html -* http://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/murano-apps -* Bug tracker - * https://launchpad.net/murano +For more specific information about contributing to this repository, see the +murano-apps contributor guide: - * 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://opendev.org/openstack/murano - - * https://opendev.org/openstack/murano-agent - - * https://opendev.org/openstack/murano-dashboard - - * https://opendev.org/openstack/python-muranoclient - - * https://opendev.org/openstack/murano-apps - -* Code Review - * https://review.opendev.org/#/q/murano+AND+status:+open,n,z - - * http://docs.openstack.org/infra/manual/developers.html#development-workflow + https://opendev.org/openstack/murano-apps/src/branch/master/doc/source/contributor/contributing.rst diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst new file mode 100644 index 00000000..5df21c4b --- /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 murano-apps. + +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-apps Core Team +`_ contacts. + +New Feature Planning +~~~~~~~~~~~~~~~~~~~~ +murano-apps 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 murano-apps project require one or two +2 votes +from murano-apps 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 +`_.