Skip to content

Commit

Permalink
Add issue templates.
Browse files Browse the repository at this point in the history
  • Loading branch information
joaander committed May 14, 2024
1 parent dcb4c52 commit a6ca3fc
Show file tree
Hide file tree
Showing 5 changed files with 91 additions and 1 deletion.
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: Bug report
description: Report a problem with row.
labels: ['bug']
body:
- type: textarea
attributes:
label: Description
description: Describe the problem.
validations:
required: true
- type: textarea
attributes:
label: Steps to reproduce
description: |
What specific commands do you execute to trigger the problem?
placeholder: |
row show status
...
render: shell
- type: textarea
attributes:
label: Input files
description: Attach any input files needed to execute the above steps.
- type: textarea
attributes:
label: Output
description: |
What output did you get?
render: shell
- type: textarea
attributes:
label: Expected output
description: What output do you expect?
- type: input
attributes:
label: Row version
description: What version of **row** are you using?
placeholder: 0.1.0
- type: markdown
attributes:
value: |
Execute `row --version` to find your **row** version.
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: true
contact_links:
- name: Row discussion board
url: https://github.com/glotzerlab/row/discussions/
about: Ask the Row user community for help.
- name: Row documentation
url: https://row.readthedocs.io/
about: User documentation.
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Feature request
description: Suggest a new **row** feature
labels: ['enhancement']
body:
- type: textarea
attributes:
label: Description
description: What new capability would you like in **row**?
validations:
required: true
- type: textarea
attributes:
label: Proposed solution
description: How should this capability be implemented? What might user interface look like?
- type: textarea
attributes:
label: Additional context
description: What additional information is helpful to understand this request?
- type: markdown
attributes:
value: |
We would welcome your contribution!
If you plan to implement this functionality, the **row** developers will discuss the
proposed design and API with you **before** you begin work.
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/task.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: Task
description: A task that needs to be completed
labels: ['task']
body:
- type: textarea
attributes:
label: Description
description: What needs to be done?
validations:
required: true
- type: textarea
attributes:
label: Motivation and context
description: What additional information is helpful to understand this task?
validations:
required: true
1 change: 0 additions & 1 deletion DESIGN.md
Original file line number Diff line number Diff line change
Expand Up @@ -294,7 +294,6 @@ status may take a long time, so it should display a progress bar.
without applying the additional submission filters.
- **workspace**: The location on the file system that contains **directories**.

# TODO: Issue templates?
# TODO: Dependabot configuration
# TODO: readthedocs builds
# TODO: logo
Expand Down

0 comments on commit a6ca3fc

Please sign in to comment.