From 378caa021c268a820418c6ac8e726658677c1a92 Mon Sep 17 00:00:00 2001 From: Ankit Chaurasia <8670962+sunank200@users.noreply.github.com> Date: Wed, 8 Nov 2023 13:46:43 +0545 Subject: [PATCH 1/2] Add github template for issues and bug reporting --- .github/ISSUE_TEMPLATE/bug_report.md | 30 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 ++++ .github/ISSUE_TEMPLATE/feature_request.md | 33 +++++++++++++++++++++++ 3 files changed, 68 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..8676e7ce --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,30 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**Version** +* OS: [eg. Debian] + +**To Reproduce** +Steps to reproduce the behavior: +1. Run Ask-Astro website or Ask-Astro Slackbot'...' +2. Run using '....' +3. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..555d9d69 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +--- +contact_links: + - name: Ask a question or get support (Forum) + url: https://github.com/astronomer/ask-astro/discussions/ + about: Ask a question or request support for using this Ask Astro diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..553e938b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,33 @@ +--- +name: Feature request for Ask Astro +about: Suggest an idea for this project +title: '' +labels: feature +assignees: '' + +--- + +**Please describe the feature you'd like to see** +A clear and concise description of what problem feature solves or what use-case it would enable. +e.g. "I really wish I could ...", "I'm sad that I can't..." + +**Describe the solution you'd like** +A clear and concise description of what you want to happen, if possible with code examples. + +**Are there any alternatives to this feature?** +Is there another way we could solve this problem or enable this use-case? + +**Additional context** +Add any other context about the feature request here. + +**Acceptance Criteria** + +- [ ] All checks and tests in the CI should pass +- [ ] Unit tests +- [ ] Integration tests (if the feature relates to a new database or external service) +- [ ] Example DAG +- [ ] Docstrings in [reStructuredText](https://peps.python.org/pep-0287/) for each of methods, classes, functions and module-level attributes (including Example DAG on how it should be used) +- [ ] Exception handling in case of errors +- [ ] Logging (are we exposing useful information to the user? e.g. source and destination) +- [ ] Improve the documentation (README, Sphinx, and any other relevant) +- [ ] How to use Guide for the feature ([example](https://airflow.apache.org/docs/apache-airflow-providers-postgres/stable/operators/postgres_operator_howto_guide.html)) From e4d25af3a21765a5c091840f22f2f8e580f814da Mon Sep 17 00:00:00 2001 From: Ankit Chaurasia <8670962+sunank200@users.noreply.github.com> Date: Wed, 8 Nov 2023 14:12:27 +0545 Subject: [PATCH 2/2] Fix based on Wei's comment --- .github/ISSUE_TEMPLATE/bug_report.md | 13 ++++++++----- .github/ISSUE_TEMPLATE/feature_request.md | 8 +++++--- 2 files changed, 13 insertions(+), 8 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 8676e7ce..56480f24 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -8,23 +8,26 @@ assignees: '' --- **Describe the bug** -A clear and concise description of what the bug is. + **Version** -* OS: [eg. Debian] +* OS: **To Reproduce** Steps to reproduce the behavior: + **Expected behavior** -A clear and concise description of what you expected to happen. + **Screenshots** -If applicable, add screenshots to help explain your problem. + **Additional context** -Add any other context about the problem here. + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 553e938b..e748ded3 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -8,17 +8,19 @@ assignees: '' --- **Please describe the feature you'd like to see** + **Describe the solution you'd like** -A clear and concise description of what you want to happen, if possible with code examples. + **Are there any alternatives to this feature?** -Is there another way we could solve this problem or enable this use-case? + **Additional context** -Add any other context about the feature request here. + **Acceptance Criteria**