diff options
author | Lingxian Kong <anlin.kong@gmail.com> | 2020-02-26 16:22:58 +1300 |
---|---|---|
committer | Lingxian Kong <anlin.kong@gmail.com> | 2020-02-26 16:22:58 +1300 |
commit | 6f1a351f04924f603a7bdaa5cd6d2ea0554bd67f (patch) | |
tree | eb740cc13b93e33b36d4557c4dcd9c32d2729139 /doc/source/contributor | |
parent | 2d301d0a21863c6c0fbb9e854c7eb8ad8f19bbc1 (diff) | |
download | trove-6f1a351f04924f603a7bdaa5cd6d2ea0554bd67f.tar.gz |
[Community goal] Add contributor and PTL guide
Change-Id: Ib52e091417eeb37607c600ac7389cfe41be4e23c
Story: #2007236
Task: #38568
Diffstat (limited to 'doc/source/contributor')
-rw-r--r-- | doc/source/contributor/contributing.rst | 84 | ||||
-rw-r--r-- | doc/source/contributor/index.rst | 1 |
2 files changed, 85 insertions, 0 deletions
diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst new file mode 100644 index 00000000..7a820a52 --- /dev/null +++ b/doc/source/contributor/contributing.rst @@ -0,0 +1,84 @@ +============================ +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 Trove. + +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-trove +- Mailing list's prefix: [trove] +- 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 Trove core reviewers is available on `gerrit +<https://review.opendev.org/#/admin/groups/99,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. + +#. Talk to the team via IRC (meeting) or ML (with [trove] prefix) about + the feature requested. We will discuss if a spec is needed based on + the implementation complexity and the + installation/configuration/upgrade/user-facing impacts. +#. If a spec is need, a patch needs to be submitted to `trove-specs repo + <https://opendev.org/openstack/trove-specs>`_ before the code being + reviewed. +#. Code implementation and review + +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/trove>`_ + +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/trove>`_. + +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 Trove 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>`_.
\ No newline at end of file diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst index 1eef881f..9a0387bb 100644 --- a/doc/source/contributor/index.rst +++ b/doc/source/contributor/index.rst @@ -9,5 +9,6 @@ functionality, the following resources are provided. .. toctree:: :maxdepth: 1 + contributing design testing |