openstack
/
oslo-specs
Code Issues Proposed changes

Add contributor doc policy 

This is the first step of completing the contributor doc goal from
the Ussuri cycle. It adds a contributing.rst policy which uses the
cookiecutter template created for the goal.

The expectation is that this is a central location for all of this
information, and the contributing.rst in each Oslo project will
simply refer to it so we aren't maintaining it in 40+ repos.

Change-Id: I3347d553b50a52ae96186e60b729360b159d8df5
This commit is contained in:
Ben Nemec 2020-04-24 16:46:36 -05:00
parent 2f3c42465b
commit 3b573d2eb5
1 changed files with 72 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

72
specs/policy/contributing.rst Normal file
View File

@ -0,0 +1,72 @@
============================
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 Oslo, which includes all of the projects listed on
`the Oslo wiki <https://wiki.openstack.org/wiki/Oslo#Libraries>`_.
Communication
~~~~~~~~~~~~~
IRC: #openstack-oslo on Freenode
Mailing list: Messages tagged with [oslo] on
`openstack-discuss <http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss>`_
Meeting: Weekly. Full details on
`eavesdrop <http://eavesdrop.openstack.org/#Oslo_Team_Meeting>`_
Contacting the Core Team
~~~~~~~~~~~~~~~~~~~~~~~~
.. TODO(bnemec): I think we should keep this list on the wiki so cores can
update their own details without waiting for reviews.
.. This section should list the core team, their irc nicks, emails, timezones
etc. If all this info is maintained elsewhere (i.e. a wiki), you can link to
that instead of enumerating everyone here.
New Feature Planning
~~~~~~~~~~~~~~~~~~~~
Oslo uses a spec process for major new features. See details
`on the wiki <https://wiki.openstack.org/wiki/Oslo#Design_Proposals>`_.
Task Tracking
~~~~~~~~~~~~~
We track our tasks in Launchpad.
https://bugs.launchpad.net/oslo
Each individual library also has its own Launchpad project.
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/oslo>`_.
Getting Your Patch Merged
~~~~~~~~~~~~~~~~~~~~~~~~~
In general, Oslo requires 2 +2's in order to merge a patch. Under some
circumstances a single +2 may be sufficient. This is generally reserved for
repetitive patches such as trivial tox changes that have been pre-approved by
the team. Some other circumstances (such as gate blocking bugs) may call for
single approval at the discretion of the core team.
Unit tests are preferred for changes that are not already covered by existing
unit tests, and will usually help patches merge more quickly.
Project Team Lead Duties
~~~~~~~~~~~~~~~~~~~~~~~~
PTL duties are documented in the
`Oslo PTL Guide <https://specs.openstack.org/openstack/oslo-specs/specs/policy/ptl.html>`_.
All common PTL duties are enumerated in the `PTL guide
<https://docs.openstack.org/project-team-guide/ptl.html>`_.