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.

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

🔧 config: add issue template config and bug report template #488

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: Bug Report
description: Report a problem in the training materials.
title: "[Bug]: "
labels: ["bug", "triage"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to report a problem in the training materials.
Note: If you are learning Nextflow and need help with the content, ask your questions in the [Seqera community forum](https://community.seqera.io/c/help/37).
- type: input
id: version
attributes:
label: Training materials version
description: What's the git commit hash of the training materials you are using?
placeholder: ex. [email protected]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this seems like the wrong kind of placeholder?

validations:
required: false
- type: textarea
id: whats-wrong
attributes:
label: What's wrong?
description: What's the problem in the training materials?
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems a bit redundant with the label, maybe state the purpose, ie are we looking for a high level summary here?

placeholder: Tell us what you see!
value: "A bug happened!"
validations:
required: true
- type: textarea
id: nextflow-code
attributes:
label: Nextflow code
description: |
If relevant, please copy and paste the Nextflow code that you used or constructed following the training materials directions.
This will be automatically formatted as Nextflow, so no need for backticks.
render: nextflow
- type: textarea
id: logs
attributes:
label: Relevant log output
description: |
Please copy and paste any relevant log output.
This will be automatically formatted as shell output, so no need for backticks.
render: shell
- type: textarea
id: additional-info
attributes:
label: Additional Info
description: Any additional information that you think might be helpful.
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: true
contact_links:
- name: Ask for help
url: https://community.seqera.io/c/help/37
about: If you are learning Nextflow and need help with the content, ask your questions in the Seqera community forum.
Loading