potiuk commented on a change in pull request #14223: URL: https://github.com/apache/airflow/pull/14223#discussion_r577836682
########## File path: docs/apache-airflow/issue-triage-process.rst ########## @@ -0,0 +1,195 @@ + .. Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + .. http://www.apache.org/licenses/LICENSE-2.0 + + .. Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + + + + +Issue reporting and resolution process +====================================== + +This document explains the issue tracking and triage process within Apache +Airflow including labels, milestones, and priorities as well as the process +of resolving issues. + +Labels +'''''' + +Since Apache Airflow uses Github Issues as the issue tracking system, the +use of labels is extensive. Though issue labels tend to change over time +based on components within the project, the majority of the ones listed +below should stand the test of time. + +The intention with the use of labels with the Apache Airflow project is +that they should ideally be non-temporal in nature and primarily used +to indicate the following elements: + +**Kind** + +The “kind” labels indicate “what kind of issue it is”. The most +commonly used “kind” labels are: bug, feature, documentation, or task. + +Therefore, when reporting an issue, the label of ``kind:bug`` is to +indicate a problem with the functionality, whereas the label of +``kind:feature`` is a desire to extend the functionality. + +There has been discussion within the project about whether to separate +the desire for “new features” from “enhancements to existing features”, +but in practice most “feature requests” are actually enhancement requests, +so we decided to combine them both into ``kind:feature``. + +We recently introduced ``kind:task`` to categorize issues which are +identified elements of work to be done, primarily as part of a larger +change to be done as part of an AIP or something which needs to be cleaned +up in the project. + +Issues of ``kind:documentation`` are for changes which need to be +made to the documentation within the project. + + +**Area** + +The “area” set of labels should indicate the component of the code +referenced by the issue. At a high level, the biggest areas of the project +are: Airflow Core and Airflow Providers, which are referenced by ``area:core`` +and ``area:providers``. This is especially important since these are now +being released and versioned independently. + +There are more detailed areas of the project such as Scheduler, Webserver, +API, UI, Logging, and Kubernetes, which are all conceptually under the +“Airflow Core” area of the project. + +Similarly, some providers are broken out such as Apache (``provider/Apache``), +AWS (``provider/AWS``), Azure (``provider/Azure``), and Google (``provider/Google``). +These make it easier for developers working on a single provider to +track issues for that provider. + +Most issues need a combination of "kind" and "area" labels to be actionable. +For example: + +* Feature request for an additional API would have ``kind:feature`` and ``area:API`` +* Bug report on the User Interface would have ``kind:bug`` and ``area:UI`` +* Documentation request on the Kubernetes Executor, would have ``kind:documentation`` and ``area:kubernetes`` + + +Response to issues +'''''''''''''''''' + +Once an issue has been created on the Airflow project, someone from the +Airflow team or the Airflow community typically responds to this issue. +This response can have multiple elements. + +**Priority** + +After significant discussion about the different priority schemes currently +being used across various projects, we decided to use a priority scheme based +on the Kubernetes project, since the team felt it was easier for people to +understand. + +Therefore, the priority labels used are: + +* ``priority:critical``: Showstopper bug that should be resolved immediately and a patch issued as soon as possible. Typically, this is because it affects most users and would take down production systems. +* ``priority:high``: A high priority bug that affects many users and should be resolved quickly, but can wait for the next scheduled patch release. +* ``priority:medium``: A bug that should be fixed before the next release, but would not block a release if found during the release process. +* ``priority:low``: A bug with a simple workaround or a nuisance that does not stop mainstream functionality. + + +It's important to use priority labels effectively so we can triage incoming issues +appropriately and make sure that when we release a new version of Airflow, +we can ship a release confident that there are no “production blocker” issues in it. Review comment: I believe yeah, this might trigger us to have an out-of-band release in case we find a critical issue - especially that we can do it easily now and nothing stops us except the efficiency/batching of voting process. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected]
