From e4096d84e7ae72f8ecb500f30fb9d2e942aae337 Mon Sep 17 00:00:00 2001 From: Roman Gorshunov Date: Fri, 24 Apr 2020 18:52:12 +0200 Subject: [PATCH] Add Project Specific Contributor and PTL Docs This patch amends contributor guidelines for the Ussuri goals. Change-Id: Idc88bf4e0f6e41c2ac1b89c700314cd9038982d4 Task: 38545 Story: 2007236 --- CONTRIBUTING.rst | 19 +++++ README.rst | 20 ++--- doc/source/contributor/contributing.rst | 108 ++++++++++++++++++++++++ doc/source/index.rst | 1 + 4 files changed, 137 insertions(+), 11 deletions(-) create mode 100644 CONTRIBUTING.rst create mode 100644 doc/source/contributor/contributing.rst diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 000000000..416ce82ba --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,19 @@ +The source repository for this project can be found at: + + https://opendev.org/openstack/openstack-helm-infra + +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 StoryBoard: + + https://storyboard.openstack.org/#!/project/openstack/openstack-helm-infra + +For more specific information about contributing to this repository, see the +openstack-helm infra contributor guide: + + https://docs.openstack.org/openstack-helm-infra/latest/contributor/contributing.html diff --git a/README.rst b/README.rst index 06039c0f9..a4720b1a0 100644 --- a/README.rst +++ b/README.rst @@ -15,20 +15,18 @@ For more information, please refer to the OpenStack-Helm repository_. Communication ------------- -* Join us on `Slack `_ - #openstack-helm * Join us on `IRC `_: #openstack-helm on freenode -* Community IRC Meetings: [Every Tuesday @ 3PM UTC], - #openstack-meeting-4 on freenode +* Community `IRC Meetings + `_: + [Every Tuesday @ 3PM UTC], #openstack-meeting-alt on freenode * Meeting Agenda Items: `Agenda `_ +* Join us on `Slack `_ + - #openstack-helm -Launchpad ---------- +Contributing +------------ -Bugs and blueprints are tracked via OpenStack-Helm's Launchpad. Any bugs or -blueprints filed in the OpenStack-Helm-Infra Launchpad will be closed and -requests will be made to file them in the appropriate location. - -* `Bugs `_ -* `Blueprints `_ +We welcome contributions. Check out `this `_ document if +you would like to get involved. diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst new file mode 100644 index 000000000..4bb7a914a --- /dev/null +++ b/doc/source/contributor/contributing.rst @@ -0,0 +1,108 @@ +============================ +So You Want to Contribute... +============================ + +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. + +Additional information could be found in +`OpenDev Developer's Guide +`_. + +Below will cover the more project specific information you need to get started +with OpenStack-Helm infra. + +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. + +* Join us on `IRC `_: + #openstack-helm on freenode +* Community `IRC Meetings + `_: + [Every Tuesday @ 3PM UTC], #openstack-meeting-alt on freenode +* Meeting Agenda Items: `Agenda + `_ +* Join us on `Slack `_ + - #openstack-helm + +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. + +Project's Core Team could be contacted via IRC or Slack, usually during weekly +meetings. List of current Cores could be found on a Members tab of +`openstack-helm-infra-core `_ +Gerrit group. + +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. + +New features are planned and implemented trough the process described in +`Project Specifications `_ +section of OpenStack-Helm documents. + +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 on our StoryBoard_. + +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. + +Other OpenStack-Helm component's tasks could be found on the `group 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 our +Storyboard_. + +If issue is on one of other OpenStack-Helm components, report it to the +appropriate `group Storyboard`_. + +Bugs should be filed as stories in Storyboard, not GitHub. + +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. + +We require two Code-Review +2's from reviewers, before getting your patch merged +with giving Workforce +1. Trivial patches (e.g. typos) could be merged with one +Code-Review +2. + +Changes affecting code base often require CI tests and documentation to be added +in the same patch set. + +Pull requests submitted through GitHub will be ignored. + +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 +`_. + +.. _Storyboard: https://storyboard.openstack.org/#!/project/openstack/openstack-helm-infra +.. _group Storyboard: https://storyboard.openstack.org/#!/project_group/64 diff --git a/doc/source/index.rst b/doc/source/index.rst index bd2b25bdd..b991d22ca 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -7,6 +7,7 @@ Contents: :maxdepth: 2 install/index + contributor/contributing testing/index monitoring/index logging/index