This is an automated email from the ASF dual-hosted git repository.
knaufk pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink-jira-bot.git
commit 77943a14746fbcdb8432863b07f0c8143d33f3fc
Author: Konstantin Knauf <knauf.konstan...@gmail.com>
AuthorDate: Fri Apr 16 11:31:51 2021 +0200
[FLINK-22033] add docstring for rule classes
---
flink_jira_bot.py | 12 ++++++++++++
1 file changed, 12 insertions(+)
diff --git a/flink_jira_bot.py b/flink_jira_bot.py
index e1cdc28..00ce80f 100644
--- a/flink_jira_bot.py
+++ b/flink_jira_bot.py
@@ -107,6 +107,12 @@ class FlinkJiraRule:
class Rule3(FlinkJiraRule):
+ """
+ An unresolved Minor ticket without an update for {stale_minor.stale_days}
is closed after a warning period of
+ {stale_minor.warning_days} with a comment that encourages users to watch,
comment and simply reopen with a higher
+ priority if the problem insists.
+ """
+
def __init__(self, jira_client, config, is_dry_run):
super().__init__(jira_client, config, is_dry_run)
self.stale_days = config["stale_minor"]["stale_days"].get()
@@ -181,6 +187,12 @@ class Rule3(FlinkJiraRule):
class Rule2(FlinkJiraRule):
+ """
+ Assigned tickets without an update for {stale_assigned.stale_days} are
unassigned after a warning period of
+ {stale_assigned.warning_days}. Before this happens the assignee is
notified that this is about to happen and
+ asked for an update on the status of her contribution.
+ """
+
def __init__(self, jira_client, config, is_dry_run):
super().__init__(jira_client, config, is_dry_run)
self.stale_days = config["stale_assigned"]["stale_days"].get()
