Browse Source

[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: #38554

Change-Id: I6feaa5e6ef9ec56094cbb725a44893aabb83dd24
changes/13/721113/3
Ghanshyam Mann 1 year ago
parent
commit
6f6fa9f2f8
3 changed files with 83 additions and 0 deletions
  1. +19
    -0
      CONTRIBUTING.rst
  2. +55
    -0
      doc/source/contributor/contributing.rst
  3. +9
    -0
      doc/source/index.rst

+ 19
- 0
CONTRIBUTING.rst View File

@ -0,0 +1,19 @@
The source repository for this project can be found at:
https://opendev.org/openstack/eslint-config-openstack
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 Launchpad:
https://bugs.launchpad.net/eslint-config-openstack
For more specific information about contributing to this repository, see the
eslint-config-openstack contributor guide:
https://docs.openstack.org/eslint-config-openstack/latest/contributor/contributing.html

+ 55
- 0
doc/source/contributor/contributing.rst View File

@ -0,0 +1,55 @@
============================
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 eslint-config-openstack.
Communication
~~~~~~~~~~~~~
* IRC channel ``#openstack-qa`` at FreeNode
* Mailing list (prefix subjects with ``[qa]`` for faster responses)
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss
Contacting the Core Team
~~~~~~~~~~~~~~~~~~~~~~~~
Please refer to the `eslint-config-openstack Core Team
<https://review.opendev.org/#/admin/groups/991,members>`_ contacts.
New Feature Planning
~~~~~~~~~~~~~~~~~~~~
If you want to propose a new feature please read `Feature Proposal Process`_
eslint-config-openstack features are tracked on `Launchpad BP <https://blueprints.launchpad.net/eslint-config-openstack>`_.
Task Tracking
~~~~~~~~~~~~~
We track our tasks in `Launchpad <https://bugs.launchpad.net/eslint-config-openstack>`_.
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/eslint-config-openstack/+filebug>`__.
More info about Launchpad usage can be found on `OpenStack docs page
<https://docs.openstack.org/contributors/common/task-tracking.html#launchpad>`_
Getting Your Patch Merged
~~~~~~~~~~~~~~~~~~~~~~~~~
All changes proposed to the eslint-config-openstack require single ``Code-Review +2`` votes
as minimum from eslint-config-openstack core reviewers who 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>`_.
The Release Process for QA is documented in `QA Release Process
<https://wiki.openstack.org/wiki/QA/releases>`_.
.. _Feature Proposal Process: https://wiki.openstack.org/wiki/QA#Feature_Proposal_.26_Design_discussions

+ 9
- 0
doc/source/index.rst View File

@ -13,6 +13,15 @@ move between projects smoothly, and overall make the code more maintainable.
Even though eslint permits overriding rules on a per-project basis, it should be
the goal of every project to stay as close to the common guidelines as possible.
For Contributor
===============
If you are a new contributor to eslint-config-openstack please refer: :doc:`contributor/contributing`
.. toctree::
:hidden:
contributor/contributing
Administrator's Guide
=====================


Loading…
Cancel
Save