Browse Source

Merge "[ussuri][goal] Update contributor documentation"

master
Zuul 6 months ago
committed by Gerrit Code Review
parent
commit
7d761bff3d
  1. 3
      .zuul.yaml
  2. 21
      CONTRIBUTING.rst
  3. 48
      doc/source/contributor/contributing.rst

3
.zuul.yaml

@ -51,6 +51,9 @@
check:
jobs:
- heat-templates-check
# This is added to merge *.rst only changes
- noop
gate:
jobs:
- heat-templates-check
- noop

21
CONTRIBUTING.rst

@ -1,16 +1,19 @@
If you would like to contribute to the development of OpenStack,
you must follow the steps in this page:
The source repository for this project can be found at:
https://docs.openstack.org/infra/manual/developers.html
https://opendev.org/openstack/heat-templates
Once those steps have been completed, changes to OpenStack
should be submitted for review via the Gerrit tool, following
the workflow documented at:
Pull requests submitted through GitHub are not monitored.
https://docs.openstack.org/infra/manual/developers.html#development-workflow
To start contributing to OpenStack, follow the steps in the contribution guide
to set up and use Gerrit:
Pull requests submitted through GitHub will be ignored.
https://docs.openstack.org/contributors/code-and-documentation/quick-start.html
Bugs should be filed on Storyboard, not GitHub:
Bugs should be filed on Storyboard,:
https://storyboard.openstack.org/#!/project/openstack/heat-templates
For more specific information about contributing to this repository, see the
heat-templates contributor guide:
https://opendev.org/openstack/heat-templates/src/branch/master/doc/source/contributor/contributing.rst

48
doc/source/contributor/contributing.rst

@ -0,0 +1,48 @@
============================
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 heat-templates.
Communication
~~~~~~~~~~~~~
* IRC channel #heat at OFTC
* Mailing list (prefix subjects with ``[heat]`` for faster responses)
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss
Contacting the Core Team
~~~~~~~~~~~~~~~~~~~~~~~~
Please refer the `heat-templates Core Team
<https://review.opendev.org/admin/groups/b4b16f97f2b8416cb0111c0bec5df885bd779347,members>`_ contacts.
New Feature Planning
~~~~~~~~~~~~~~~~~~~~
heat-templates features are tracked on `Storyboard <https://storyboard.openstack.org/#!/project/openstack/heat>`_.
Please specify the reported story with `heat-templates`.
Task Tracking
~~~~~~~~~~~~~
We track our tasks in `Storyboard <https://storyboard.openstack.org/#!/project/openstack/heat>`_.
Please specify the reported story with `heat-templates`.
Reporting a Bug
~~~~~~~~~~~~~~~
You found an issue and want to make sure we are aware of it? You can do so on
`Storyboard <https://storyboard.openstack.org/#!/project/openstack/heat>`_.
Please specify the reported story with `heat-templates`.
Getting Your Patch Merged
~~~~~~~~~~~~~~~~~~~~~~~~~
All changes proposed to the heat-templates project require one or two +2 votes
from heat-templates 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>`_.
Loading…
Cancel
Save