Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add github template for issues and bug reporting #92

Merged
merged 2 commits into from
Nov 8, 2023
Merged

Add github template for issues and bug reporting #92

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
378caa0
Add github template for issues and bug reporting
sunank200 Nov 8, 2023
e4d25af
Fix based on Wei's comment
sunank200 Nov 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
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: <!--A clear and concise description of what the bug is.-->

**To Reproduce**
Steps to reproduce the behavior:
<!--
Steps to reproduce the behavior:
1. Run Ask-Astro website or Ask-Astro Slackbot'...'
2. Run using '....'
3. See error
sunank200 marked this conversation as resolved.
Show resolved Hide resolved
-->

**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.-->
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
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..."
sunank200 marked this conversation as resolved.
Show resolved Hide resolved
-->

**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))
Loading