[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: #38521
Change-Id: I7f2fc02c036d71d76e1b6f69879641fef3271207
changes/29/791329/1
Ghanshyam Mann 2 years ago
parent c0f612e5f1
commit 084d252809

@ -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:
http://docs.openstack.org/infra/manual/developers.html
https://opendev.org/openstack/ec2-api
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.
http://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 Launchpad, not GitHub:
Bugs should be filed on Launchpad:
https://bugs.launchpad.net/ec2-api
https://bugs.launchpad.net/ec2-api
For more specific information about contributing to this repository, see the
ec2-api contributor guide:
https://docs.openstack.org/ec2-api/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 ec2-api.
Communication
~~~~~~~~~~~~~
* IRC channel #openstack-ec2api at FreeNode
* Mailing list (prefix subjects with ``[ec2-api]`` for faster responses)
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss
Contacting the Core Team
~~~~~~~~~~~~~~~~~~~~~~~~
Please refer the `ec2-api Core Team
<https://review.opendev.org/admin/groups/243cf9ceaa59c417ffd4e421a88afa4d9a415dcb,members>`_ contacts.
New Feature Planning
~~~~~~~~~~~~~~~~~~~~
ec2-api features are tracked on `Launchpad <https://bugs.launchpad.net/ec2-api>`_.
Task Tracking
~~~~~~~~~~~~~
We track our tasks in `Launchpad <https://bugs.launchpad.net/ec2-api>`_.
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/ec2-api>`_.
Getting Your Patch Merged
~~~~~~~~~~~~~~~~~~~~~~~~~
All changes proposed to the ec2-api project require one +2 votes
from ec2-api 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>`_.

@ -52,6 +52,16 @@ EC2API Reference
hacking
For Contributors
================
* If you are a new contributor to ec2-api please refer: :doc:`contributor/contributing`
.. toctree::
:hidden:
contributor/contributing
Indices and tables
==================

Loading…
Cancel
Save