From dd30a88eb659aad6f4577a5401652160b27222b2 Mon Sep 17 00:00:00 2001 From: Lance Bragstad Date: Tue, 14 May 2019 18:55:15 +0000 Subject: [PATCH] Update the meaning of low-hanging-fruit During the Train PTG, the team discussed ways to better engage newcomers and folks who don't have fulltime responsibility upstream. One way we can do that is by doing a better job describing and applying `low-hanging-fruit` in bug triage. This commit attempts to introduce consistency for that specific bug tag. Change-Id: Ib6ea0b62ad95335ed2d9b26687708cd664bf3648 --- doc/source/contributor/how-can-i-help.rst | 25 +++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/doc/source/contributor/how-can-i-help.rst b/doc/source/contributor/how-can-i-help.rst index 72b97ce7c6..bbe9b86fe7 100644 --- a/doc/source/contributor/how-can-i-help.rst +++ b/doc/source/contributor/how-can-i-help.rst @@ -55,3 +55,28 @@ Need any help? `Reach out`_ to the keystone team. .. _new changes: https://review.opendev.org/#/q/is:open+project:openstack/keystone+OR+project:openstack/keystonemiddleware+OR+project:openstack/keystoneauth+OR+project:openstack/python-keystoneclient .. _review guidelines: https://docs.openstack.org/project-team-guide/review-the-openstack-way.html .. _Reach out: ../getting-started/community.html + +The Meaning of Low Hanging Fruit +================================ + +This section describes the intent behind bugs tagged as low hanging fruit. +Current maintainers should apply the tag consistently while triaging bugs, +using this document as a guide. This practice ensures newcomers to the project +can expect each low hanging fruit bug to be of similar complexity. + +Bugs fit for the low hanging fruit tag: + +* Should require minimal python experience, someone new to OpenStack might also + be new to python +* Should only require a basic understanding of the review workflow, complicated + changesets with dependencies between repositories coupled with CI testing + only raises the cognitive bar for new contributors +* Can include documentation fixes so long it doesn't require an + in-depth understanding of complicated subsystems and features (e.g., + overhauling the federated identity guide) +* Should be something a newcomer can progress through in a week or less, long + wait times due to the discussion of complicated topics can deter new + contributors from participating +* Shouldn't require a new contributor to understand copious amounts of + historical context, newcomers should eventually understand this information + but consuming that information is outside the scope of low hanging fruit