diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..aa011c1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -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. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..4a6256a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..eb5334a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -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. diff --git a/.github/ISSUE_TEMPLATE/task.yml b/.github/ISSUE_TEMPLATE/task.yml new file mode 100644 index 0000000..e6a4e6b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/task.yml @@ -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 diff --git a/DESIGN.md b/DESIGN.md index f6a2dbd..6fcc9c6 100644 --- a/DESIGN.md +++ b/DESIGN.md @@ -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