From 4eb44b6483031358e8d339297b76ec8fe7155611 Mon Sep 17 00:00:00 2001 From: Michaela Robosova Date: Thu, 29 May 2025 04:55:18 +0200 Subject: [PATCH 1/2] Set up default issue templates --- .../{bug_report.md => bug_issue.md} | 13 +++++- .github/ISSUE_TEMPLATE/config.yml | 8 ++++ .github/ISSUE_TEMPLATE/enhancement_issue.md | 41 +++++++++++++++++++ .../ISSUE_TEMPLATE/{epic.md => epic_issue.md} | 11 +++++ .github/ISSUE_TEMPLATE/other_issue.md | 17 ++++++++ .github/ISSUE_TEMPLATE/product_issue.md | 18 ++++++-- 6 files changed, 104 insertions(+), 4 deletions(-) rename .github/ISSUE_TEMPLATE/{bug_report.md => bug_issue.md} (71%) create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/enhancement_issue.md rename .github/ISSUE_TEMPLATE/{epic.md => epic_issue.md} (83%) create mode 100644 .github/ISSUE_TEMPLATE/other_issue.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_issue.md similarity index 71% rename from .github/ISSUE_TEMPLATE/bug_report.md rename to .github/ISSUE_TEMPLATE/bug_issue.md index e7ae6ff..d42b4b8 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_issue.md @@ -4,6 +4,17 @@ about: Report a bug to help us improve title: "[Brief description]" --- + + + + + +❌ **This issue is not open for contribution. Visit Contributing guidelines** to learn about the contributing process and how to find suitable issues. + + + + + diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..18d4fe4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: Kolibri GitHub Discussions + url: https://github.com/learningequality/kolibri/discussions + about: Please ask general questions about contributing to Kolibri or report development server issues here. + - name: Learning Equality Community Forum + url: https://community.learningequality.org/ + about: Ask and answer questions about Learning Equality's products and tools, share your experiences using Kolibri, and connect with users around the world. diff --git a/.github/ISSUE_TEMPLATE/enhancement_issue.md b/.github/ISSUE_TEMPLATE/enhancement_issue.md new file mode 100644 index 0000000..cfcc3ff --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement_issue.md @@ -0,0 +1,41 @@ +--- +name: Enhancement request +about: Suggest an idea +title: "[Title]: [Brief description]" +--- + + + + + + + + +❌ **This issue is not open for contribution. Visit Contributing guidelines** to learn about the contributing process and how to find suitable issues. + + + + + +## Desired behavior + + + +## Current behavior + + + +## Value add + + + +## Possible tradeoffs + diff --git a/.github/ISSUE_TEMPLATE/epic.md b/.github/ISSUE_TEMPLATE/epic_issue.md similarity index 83% rename from .github/ISSUE_TEMPLATE/epic.md rename to .github/ISSUE_TEMPLATE/epic_issue.md index b14d923..1159a3e 100644 --- a/.github/ISSUE_TEMPLATE/epic.md +++ b/.github/ISSUE_TEMPLATE/epic_issue.md @@ -7,6 +7,17 @@ assignees: '' --- + + + + + +❌ **This issue is not open for contribution. Visit Contributing guidelines** to learn about the contributing process and how to find suitable issues. + + + + + _[General guidance: When drafting a feature project, the goal is to create a reference for project scope and context. Write for our core product team. The issue should not be overly technical, and should be be comprehensible and a useful reference to devs, designers, and QA team, to build a shared source of understanding. Anyone at LE should be able to read this and more or less understand the project. If there is relevant information or context that is for the internal team only, please add that in a notion page and link it, rather than adding directly to these issues.]_ ## Overview diff --git a/.github/ISSUE_TEMPLATE/other_issue.md b/.github/ISSUE_TEMPLATE/other_issue.md new file mode 100644 index 0000000..608202d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/other_issue.md @@ -0,0 +1,17 @@ +--- +name: Other issue +about: For issues that don't fit any other category +--- + + + + + + +❌ **This issue is not open for contribution. Visit Contributing guidelines** to learn about the contributing process and how to find suitable issues. + + + + + +## Description diff --git a/.github/ISSUE_TEMPLATE/product_issue.md b/.github/ISSUE_TEMPLATE/product_issue.md index 1d36932..66a2bad 100644 --- a/.github/ISSUE_TEMPLATE/product_issue.md +++ b/.github/ISSUE_TEMPLATE/product_issue.md @@ -1,20 +1,32 @@ --- -name: Product Issue +name: Product issue about: Create a product issue assignees: '' --- + + + + + +❌ **This issue is not open for contribution. Visit Contributing guidelines** to learn about the contributing process and how to find suitable issues. + + + + + + _[General guidance: Product issues should describe the feature, but are not actually technically specced for dev work.]_ -## Overview +## Overview _[First, the workflow in one sentence]_ #### Description and outcomes _[Then, more detail. Provide a short summary and/or list key outcomes that the user should be able to accomplish with this feature.]_ - + #### Resources - [ ] _[Link Gherkin Scenarios]_ From 93323a9471e4f08224e8c63b1757faec9e211a4d Mon Sep 17 00:00:00 2001 From: Michaela Robosova Date: Thu, 29 May 2025 05:06:50 +0200 Subject: [PATCH 2/2] Turn on issue header action to work on .github repository issues as well. --- .github/workflows/manage-issue-header.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/manage-issue-header.yml b/.github/workflows/manage-issue-header.yml index 6f47a17..ecb0ec3 100644 --- a/.github/workflows/manage-issue-header.yml +++ b/.github/workflows/manage-issue-header.yml @@ -1,6 +1,8 @@ name: Manage issue header on: + issues: + types: [labeled, unlabeled] workflow_call: secrets: LE_BOT_APP_ID: