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

Update issue templates #42

Merged
merged 10 commits into from
May 2, 2024
Merged
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
123 changes: 123 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
name: Bug report
title: "[Bug] "
description: Problems and issues
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thank you for reporting the problem!
Please make sure that what you are reporting is a bug with reproducible steps.

- type: checkboxes
attributes:
label: Search before asking
description: >
Please make sure to search in the [issues](https://github.com/IBM/data-prep-lab/issues) first to see
whether the same issue was reported already.
options:
- label: >
I searched the [issues](https://github.com/IBM/data-prep-lab/issues) and found no similar
issues.
required: true

- type: dropdown
attributes:
label: Component
description: |
To what component is the bug assigned.
multiple: true
options:
- CI/CD
- Documentation
- KFP workflows
- Library/core
- Library/kfp
- Makefiles
- Transforms/code/code_quality
- Transforms/code/proglang_select
- Transforms/code/malware
- Transforms/universal/doc_id
- Transforms/universal/ededup
- Transforms/universal/fdedup
- Transforms/universal/noop
- Transforms/universal/tokenization
- Transforms/Other
- Other
validations:
required: true

- type: textarea
attributes:
label: What happened + What you expected to happen
description: Describe 1. the bug 2. expected behavior 3. useful information (e.g., logs)
placeholder: >
Please provide the context in which the problem occurred and explain what happened. Further,
please also explain why you think the behaviour is erroneous. It is extremely helpful if you can
copy and paste the fragment of logs showing the exact error messages or wrong behaviour here.

**NOTE**: please copy and paste texts instead of taking screenshots of them for easy future search.
validations:
required: true

- type: textarea
attributes:
label: Reproduction script
description: >
Please provide a reproducible script. Providing a narrow reproduction (minimal / no external dependencies) will
help us triage and address issues in the timely manner!
placeholder: >
Please provide a short code snippet (less than 50 lines if possible) that can be copy-pasted to
reproduce the issue. The snippet should have **no external library dependencies**
(i.e., use fake or mock data / environments).

validations:
required: true

- type: textarea
attributes:
label: Anything else
description: Anything else we need to know?
placeholder: >
How often does this problem occur? (Once? Every time? Only when certain conditions are met?)
Any relevant logs to include? Are there other relevant issues?

- type: dropdown
attributes:
label: OS
description: |
What operating system
multiple: true
options:
- Ubuntu
- Redhat
- Windows
- Other
validations:
required: true

- type: dropdown
attributes:
label: Python
description: |
What version of python
multiple: true
options:
- 3.10
- 3.11
- Other
validations:
required: true

- type: checkboxes
attributes:
label: Are you willing to submit a PR?
description: >
This is absolutely not required, but we are happy to guide you in the contribution process
especially if you already have a good understanding of how to implement the fix.
options:
- label: Yes I am willing to submit a PR!

- type: markdown
attributes:
value: "Thanks for completing our form!"
19 changes: 19 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<!-- Thank you for your contribution! -->

<!-- Please add a reviewer to the assignee section when you create a PR. If you don't have the access to it, we will shortly find a reviewer and assign them to your PR. -->

## Why are these changes needed?

<!-- Please give a short summary of the change and the problem this solves. -->

## Related issue number

<!-- For example: "Closes #1234" -->

## Checks

- [ ] I've made sure the tests are passing.
- Testing Strategy
- [ ] Unit tests
- [ ] Manual tests
- [ ] This PR is not tested :(