[ussuri][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: #38522 Change-Id: Id2d951e5a080565796f765f70c678c78bb3958da
This commit is contained in:
parent
c1c0d57ede
commit
abf50fe06c
19
CONTRIBUTING.rst
Normal file
19
CONTRIBUTING.rst
Normal file
@ -0,0 +1,19 @@
|
||||
The source repository for this project can be found at:
|
||||
|
||||
https://opendev.org/openstack/freezer-web-ui
|
||||
|
||||
Pull requests submitted through GitHub are not monitored.
|
||||
|
||||
To start contributing to OpenStack, follow the steps in the contribution guide
|
||||
to set up and use Gerrit:
|
||||
|
||||
https://docs.openstack.org/contributors/code-and-documentation/quick-start.html
|
||||
|
||||
Bugs should be filed on Storyboard:
|
||||
|
||||
https://storyboard.openstack.org/#!/project/openstack/freezer-web-ui
|
||||
|
||||
For more specific information about contributing to this repository, see the
|
||||
freezer-web-ui contributor guide:
|
||||
|
||||
https://opendev.org/openstack/freezer-web-ui/src/branch/master/doc/source/contributor/contributing.rst
|
47
doc/source/contributor/contributing.rst
Normal file
47
doc/source/contributor/contributing.rst
Normal file
@ -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 freezer-web-ui.
|
||||
|
||||
Communication
|
||||
~~~~~~~~~~~~~
|
||||
* IRC channel #openstack-freezer at OFTC
|
||||
* Mailing list (prefix subjects with ``[freezer]`` for faster responses)
|
||||
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss
|
||||
|
||||
Contacting the Core Team
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Please refer the `freezer-web-ui Core Team
|
||||
<https://review.opendev.org/admin/groups/489539270c16cfb7990bb3f1a0f62f3e45a94635,members>`_ contacts.
|
||||
|
||||
New Feature Planning
|
||||
~~~~~~~~~~~~~~~~~~~~
|
||||
freezer-web-ui features are tracked on `Storyboard <https://storyboard.openstack.org/#!/project/openstack/freezer-web-ui>`_.
|
||||
|
||||
Task Tracking
|
||||
~~~~~~~~~~~~~
|
||||
We track our tasks in `Storyboard <https://storyboard.openstack.org/#!/project/openstack/freezer-web-ui>`_.
|
||||
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
|
||||
`Storyboard <https://storyboard.openstack.org/#!/project/openstack/freezer-web-ui>`_.
|
||||
|
||||
Getting Your Patch Merged
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
All changes proposed to the freezer-web-ui project require one +2 votes
|
||||
from freezer-web-ui core reviewers with approving 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>`_.
|
@ -11,7 +11,15 @@ Contents:
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
For Contributors
|
||||
================
|
||||
|
||||
* If you are a new contributor to freezer-web-ui please refer: :doc:`contributor/contributing`
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
contributor/contributing
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
Loading…
Reference in New Issue
Block a user