Browse Source

[Community goal] Add contributor and PTL guide

Change-Id: I1d37aa87e7d09d2a45bfbeaac9a564771989f88d
Story: #2007236
Task: #38553
changes/49/709949/1
Lingxian Kong 1 year ago
parent
commit
a6f9577141
2 changed files with 80 additions and 5 deletions
  1. +79
    -4
      doc/source/contributor/contributing.rst
  2. +1
    -1
      doc/source/contributor/index.rst

+ 79
- 4
doc/source/contributor/contributing.rst View File

@ -1,4 +1,79 @@
============
Contributing
============
.. include:: ../../../CONTRIBUTING.rst
============================
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 Qinling.
Communication
~~~~~~~~~~~~~~
.. This would be a good place to put the channel you chat in as a project; when/
where your meeting is, the tags you prepend to your ML threads, etc.
- IRC channel: #openstack-qinling
- Mailing list's prefix: [qinling]
- Currently, we don't have team meeting given we have a small group of core
reviewers and their timezones, the situation may change in the future.
Contacting the Core Team
~~~~~~~~~~~~~~~~~~~~~~~~~
.. 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.
The list of current Qinling core reviewers is available on `gerrit
<https://review.opendev.org/#/admin/groups/1765,members>`_.
New Feature Planning
~~~~~~~~~~~~~~~~~~~~
.. This section is for talking about the process to get a new feature in. Some
projects use blueprints, some want specs, some want both! Some projects
stick to a strict schedule when selecting what new features will be reviewed
for a release.
Qinling doesn't use launchpad or separate specs repo for feature requirement.
You only need to create a task in `Storyboard
<https://storyboard.openstack.org/#!/project/openstack/qinling>`_.
Task Tracking
~~~~~~~~~~~~~~
.. This section is about where you track tasks- launchpad? storyboard? is there more
than one launchpad project? what's the name of the project group in storyboard?
We track our tasks in `Storyboard
<https://storyboard.openstack.org/#!/project/openstack/qinling>`_
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
~~~~~~~~~~~~~~~
.. Pretty self explanatory section, link directly to where people should report bugs for
your project.
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/qinling>`_.
Getting Your Patch Merged
~~~~~~~~~~~~~~~~~~~~~~~~~
.. This section should have info about what it takes to get something merged. Do
you require one or two +2's before +W? Do some of your repos require unit test
changes with all patches? etc.
Due to the small number of core reviewers of the Qinling project, we only need
one +2 before ``Workflow +1``.
Project Team Lead Duties
------------------------
.. this section is where you can put PTL specific duties not already listed in
the common PTL guide (linked below) or if you already have them written
up elsewhere, you can link to that doc here.
All common PTL duties are enumerated here in the `PTL guide
<https://docs.openstack.org/project-team-guide/ptl.html>`_.

+ 1
- 1
doc/source/contributor/index.rst View File

@ -25,10 +25,10 @@ project.
.. toctree::
:maxdepth: 1
contributing
development-environment-devstack
architecture
Setting up your development Apache mod_wsgi/uWSGI <mod-wsgi>
contributing
Indices and tables
------------------


Loading…
Cancel
Save