From 9494a35b8df0e3e3d1fefb4a419df81402d33774 Mon Sep 17 00:00:00 2001 From: Feilong Wang Date: Sat, 11 Apr 2020 11:11:35 +1200 Subject: [PATCH] Ussuri contributor docs community goal Task: 38534 Story: 2007236 Change-Id: Idda1799b3d00b9e0b2b85f1fa5cb5455abe7b1f2 --- CONTRIBUTING.rst | 82 ++++++++++++++++++++++--- doc/source/contributor/contributing.rst | 3 - 2 files changed, 72 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index c48267551b..d5746c59fa 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,16 +1,78 @@ -If you would like to contribute to the development of OpenStack, -you must follow the steps in this page: +============================ +So You Want to Contribute... +============================ - http://docs.openstack.org/infra/manual/developers.html +For general information on contributing to OpenStack, please check out the +`contributor guide `_ 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. -Once those steps have been completed, changes to OpenStack -should be submitted for review via the Gerrit tool, following -the workflow documented at: +Below will cover the more project specific information you need to get started +with Magnum. - http://docs.openstack.org/infra/manual/developers.html#development-workflow +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. -Pull requests submitted through GitHub will be ignored. +- IRC channel: #openstack-containers +- Mailing list's prefix: [magnum] +- Currently, we have a weekly team meeting at 9:00 UTC, please check `here + `_ + for more details. -Bugs should be filed on Storyboard, not GitHub: +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 Magnum core reviewers is available on `gerrit +`_. + +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. + +Magnum is using a dedicated `specs repo +`_ for feature requirement. + +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 +`_ + +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 `_. + +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. + +Though we have a small number of core reviewers of the Magnum project, we still +need two +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://storyboard.openstack.org/#!/project/openstack/magnum diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst index 2aa0707710..b1cd2f37dc 100644 --- a/doc/source/contributor/contributing.rst +++ b/doc/source/contributor/contributing.rst @@ -1,4 +1 @@ -============ -Contributing -============ .. include:: ../../../CONTRIBUTING.rst