Minimise info in CONTRIBUTING.rst

This reverts commit ed3a0b07c7 so that the
CONTRIBUTING.rst file contains only the same information that it
historically had, plus adds links to the canonical OpenDev repo and the
new project-specific contributor documentation.

It also links to the new quick-start page in the Contributor Guide
instead of the OpenStack Infra manual, as the latter is expected to be
moved to OpenDev and scrubbed of OpenStack-specific information.

This has the effect of minimising the amount of information contained in
each repo's CONTRIBUTING file, in favour of keeping it in one place in
the Contributor Guide that can easily be kept up to date.

The content of the new project-specific contributor docs template is
moved back to the docs tree, with some minor cleanups, instead of
transcluding it.

Change-Id: I02dd34a1cf6b62d12f7a26d21b3a2857d82d1b0a
Depends-On: https://review.opendev.org/708939
This commit is contained in:
Zane Bitter 2020-02-19 11:17:56 -05:00
parent ed3a0b07c7
commit 7bfef146ff
2 changed files with 82 additions and 63 deletions

View File

@ -1,43 +1,15 @@
============================
So You Want to Contribute...
============================
The source repository for this project can be found at:
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.
https://opendev.org/{{ cookiecutter.repo_group }}/{{ cookiecutter.repo_name }}
We do NOT use Github for reviewing code, pull requests submitted there will
be ignored.
Pull requests submitted through GitHub are not monitored.
Below will cover the more project specific information you need to get started
with {{cookiecutter.service}}.
To start contributing to OpenStack, follow the steps in the contribution guide
to set up and use Gerrit:
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.
https://docs.openstack.org/contributors/code-and-documentation/quick-start.html
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.
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.
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 {{ cookiecutter.bug_tracker }}
Bugs should be filed on {{ cookiecutter.bug_tracker }}:
{%- if cookiecutter.bug_tracker == 'Launchpad' -%}
https://bugs.launchpad.net/{{ cookiecutter.bug_project }}
@ -45,31 +17,7 @@ We track our tasks in {{ cookiecutter.bug_tracker }}
https://storyboard.openstack.org/#!/project/{{ cookiecutter.bug_project }}
{%- endif -%}
If you're looking for some smaller, easier work item to pick up and get started
on, search for the 'low-hanging-fruit' tag.
.. NOTE: If your tag is not 'low-hanging-fruit' please change the text above.
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
$HERE.
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.
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>`_.
For more specific information about contributing to this repository, see the
{{ cookiecutter.service }} contributor guide:
https://docs.openstack.org/{{ cookiecutter.repo_name }}/latest/contributor/contributing.html

View File

@ -1 +1,72 @@
.. 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 {{cookiecutter.service}}.
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.
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.
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.
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 {{ cookiecutter.bug_tracker }}
{%- if cookiecutter.bug_tracker == 'Launchpad' -%}
https://bugs.launchpad.net/{{ cookiecutter.bug_project }}
{%- elif cookiecutter.bug_tracker == 'Storyboard' -%}
https://storyboard.openstack.org/#!/project/{{ cookiecutter.bug_project }}
{%- endif -%}
If you're looking for some smaller, easier work item to pick up and get started
on, search for the 'low-hanging-fruit' tag.
.. NOTE: If your tag is not 'low-hanging-fruit' please change the text above.
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
$HERE.
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.
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 in the `PTL guide
<https://docs.openstack.org/project-team-guide/ptl.html>`_.