Skip to content

Commit

Permalink
Merge pull request #1 from lwpk110/feature/issue_templ
Browse files Browse the repository at this point in the history
feat: add issue template
  • Loading branch information
lwpk110 committed May 21, 2024
2 parents be58009 + 77e0fdf commit db343f0
Show file tree
Hide file tree
Showing 4 changed files with 125 additions and 0 deletions.
69 changes: 69 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report_template.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
name: "\U0001F41E Bug report"
title: "[BUG]..."
description: Report a bug
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report! Before you get started, please [search to see](https://github.com/zncdatadev/kubedatastack/issues) if an issue already exists for the bug you encountered
- type: textarea
id: bug-description
attributes:
label: Describe the bug
description: Please provide a concise description of what the bug is, in clear English. If you intend to submit a PR for this issue, tell us in the description.
placeholder: Bug description
validations:
required: true
- type: checkboxes
attributes:
label: Have you searched existing issues? 🔎
description: Please search to see if an issue already exists for the issue you encountered.
options:
- label: I have searched and found no existing issues
required: true
- type: textarea
id: reproduction
attributes:
label: Reproduction
description: Please provide a minimal example, with code, that can be run to reproduce the issue. Do NOT provide screenshots of code, or link to external repos or applications. Use ``` to format code blocks.
placeholder: Reproduction
value: |
```go
```
validations:
required: true
- type: textarea
id: screenshot
attributes:
label: Screenshot
description: If relevant, please include screenshot(s) of your Gradio app so that we can understand what the issue is.
- type: textarea
id: logs
attributes:
label: Logs
description: "Please include the full stacktrace of the errors you get from golang code. "
render: shell
- type: textarea
id: system-info
attributes:
label: System Info
description: Please ensure you are running the latest version of the operator.
render: shell
validations:
required: true
- type: dropdown
id: severity
attributes:
label: Severity
description: Select the severity of this issue
options:
- I can work around it
- Blocking usage of gradio
validations:
required: true
- type: markdown
attributes:
value: |
📌 Please ensure that you have filled all of the required sections above, and that the reproduction you have provided is [minimal, complete, and reproducible](https://stackoverflow.com/help/minimal-reproducible-example). Incomplete issues will be closed.
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: 💡 KubeDataStack Documentation
url: https://zncdata.dev/docs/
about: All about the KubeDataStack project
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: ⚡ Feature request
title: "[FEATURE]..."
description: Suggest a new idea!
labels: ['enhancement']
body:
- type: markdown
attributes:
value: |
First, check out our [Collaboration Guide](https://zncdata.dev/docs/developer-manual/collaboration)
Please provide a searchable summary of the issue in the title above ⬆️.
- type: checkboxes
attributes:
label: Duplicates
description: Please [search the history](https://github.com/zncdatadev/kubedatastack/issues) to see if an issue already exists for the same problem.
options:
- label: I have searched the existing issues
required: true
- type: textarea
attributes:
label: Summary 💡
description: Describe how it should work.
- type: textarea
attributes:
label: Examples 🌈
description: Provide a link to other implementations, or screenshots of the expected behavior.
- type: textarea
attributes:
label: Motivation 🔦
description: What are you trying to accomplish? How has the lack of this feature affected you? Providing context helps us come up with a solution that is more useful in the real world.
22 changes: 22 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: CI

on: ['push', 'pull_request']

jobs:
markdown-lint:
name: Markdown Lint
runs-on: ubuntu-22.04
steps:
- name: Checkout Code
uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Lint Code Base
uses: github/super-linter@v4
env:
VALIDATE_MARKDOWN: true
VALIDATE_ALL_CODEBASE: false
DEFAULT_BRANCH: main
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
LINTER_RULES_PATH: /
MARKDOWN_CONFIG_FILE: .markdownlint.yml

0 comments on commit db343f0

Please sign in to comment.