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

Move to new style issue template system #8898

Merged
merged 7 commits into from
Sep 2, 2021
Merged
Show file tree
Hide file tree
Changes from 3 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
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: "\U0001F41B Bug report"
about: To help the developer act on the issues, please include a description of your environment, preferably a minimum script to reproduce the problem.
title: "[Bug] "

---

Thanks for participating in the TVM community! We use https://discuss.tvm.ai for any general usage questions and discussions. The issue tracker is used for actionable items such as feature proposals discussion, roadmaps, and bug tracking. You are always welcomed to post on the forum first :smile_cat:

Issues that are inactive for a period of time may get closed. We adopt this policy so that we won't lose track of actionable issues that may fall at the bottom of the pile. Feel free to reopen a new one if you feel there is an additional problem that needs attention when an old one gets closed.

### Expected behavior

What you were expecting

### Actual behavior

What actually happened

### Environment

Any environment details, such as: Operating System, TVM version, etc

### Steps to reproduce

Preferably a minimal script to cause the issue to occur.
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/ci-update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
name: "\U0001F40B Update CI Docker Image"
about: Provide information on CI Docker Images requiring updates
title: "[CI] "
Copy link
Contributor

Choose a reason for hiding this comment

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

I would suggest using other tags like [Docker] or something else for updating CI docker images, because [CI] looks more like an CI issue (e.g., flaky test, machine down, etc) at the first glance. Since CI issue is not really a bug, we could still have a CI issue template to let users report CI running issues.

Copy link
Member

Choose a reason for hiding this comment

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

On the other hand, [Docker] is a confusing name too, which might sound like docker-related but it’s actually CI upgrade 😆

Copy link
Member

Choose a reason for hiding this comment

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

What about [CI Image]

Copy link
Member Author

Choose a reason for hiding this comment

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

I was inclined to suggest we limit the amount of issue types but then this PR failed CI, so I've changed this to [CI Image] and created a [CI Issue] template as well. I don't think that's too many for people to pick through?

It's also worth noting we can use label as well as the title here if we wanted to create labels for filtering on, I would need someones help to make appropriate labels though.

Copy link
Contributor

@comaniac comaniac Sep 1, 2021

Choose a reason for hiding this comment

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

[CI Image] looks good to me. [CI Issue] looks a bit funny tho, as we are already creating an "issue" here lol
I'm fine if others feel CI failures are a kind of bugs. The downside is I don't think people can add labels to an issue by themselves unless they have the write permission (i.e., committer). It means we will need a committer to help add labels manually for created issues; otherwise we will need a bot to automatically add labels based on the issue content.

Copy link
Member Author

Choose a reason for hiding this comment

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

By the power of the thesaurus I have renamed it CI Problem, though keen to hear whether people think we need another category.

On the labels point, the config appears to let me set labels, so I'm curious if it'll actually apply them when we open those issue types. When we see if that works we can decide if we want to try more of it?

Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not sure either. Maybe someone else could confirm? Anyways, I'm good with the current change.

Copy link
Member Author

Choose a reason for hiding this comment

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

Following up on this thread, a new bug was raised (#8925) which had the label auto-applied so the config here overrides the need for a committer 🎉


---

Thanks for participating in the TVM community! We use https://discuss.tvm.ai for any general usage questions and discussions. The issue tracker is used for actionable items such as feature proposals discussion, roadmaps, and bug tracking. You are always welcomed to post on the forum first :smile_cat:

Issues that are inactive for a period of time may get closed. We adopt this policy so that we won't lose track of actionable issues that may fall at the bottom of the pile. Feel free to reopen a new one if you feel there is an additional problem that needs attention when an old one gets closed.

- [ ] S0. Reason: For example, a blocked PR or a feature issue

- [ ] S1. Tag of nightly build: TAG. Docker hub: https://hub.docker.com/layers/tlcpackstaging/ci_cpu/...

- [ ] S2. The nightly is built on TVM commit: TVM_COMMIT. Detailed info can be found here: https://ci.tlcpack.ai/blue/organizations/jenkins/docker-images-ci%2Fdaily-docker-image-rebuild/detail/daily-docker-image-rebuild/....

- [ ] S3. Testing the nightly image on ci-docker-staging: https://ci.tlcpack.ai/blue/organizations/jenkins/tvm/detail/ci-docker-staging/...

- [ ] S4. Retag TAG to VERSION:
```
docker pull tlcpackstaging/IMAGE_NAME:TAG
docker tag tlcpackstaging/IMAGE_NAME:TAG tlcpack/IMAGE_NAME:VERSION
docker push tlcpack/IMAGE_NAME:VERSION
```

- [ ] S5. Check if the new tag is really there: https://hub.docker.com/u/tlcpack

- [ ] S6. Submit a PR updating the IMAGE_NAME version on Jenkins
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 # default: true
contact_links:
- name: 💬 Discourse
url: https://discuss.tvm.apache.org/
about: Thanks for participating in the TVM community! We use https://discuss.tvm.ai for any general usage questions and discussions. The issue tracker is used for actionable items such as feature proposals discussion, roadmaps, and bug tracking. You are always welcomed to post on the forum first 😺
Original file line number Diff line number Diff line change
@@ -1,7 +1,14 @@
Thanks for participating in the TVM community! We use https://discuss.tvm.ai for any general usage questions and discussions. The issue tracker is used for actionable items such as feature proposals discussion, roadmaps, and bug tracking. You are always welcomed to post on the forum first :)
---
name: "\U0001F527 Feature Tracking"
about: List clear, small actionable items so we can track the progress of the change.
labels: type:rfc-tracking
title: "[Tracking Issue] "

Issues that are inactive for a period of time may get closed. We adopt this policy so that we won't lose track of actionable issues that may fall at the bottom of the pile. Feel free to reopen a new one if you feel there is an additional problem that needs attention when an old one gets closed.
---

Thanks for participating in the TVM community! We use https://discuss.tvm.ai for any general usage questions and discussions. The issue tracker is used for actionable items such as feature proposals discussion, roadmaps, and bug tracking. You are always welcomed to post on the forum first :smile_cat:

For bug reports, to help the developer act on the issues, please include a description of your environment, preferably a minimum script to reproduce the problem.
Issues that are inactive for a period of time may get closed. We adopt this policy so that we won't lose track of actionable issues that may fall at the bottom of the pile. Feel free to reopen a new one if you feel there is an additional problem that needs attention when an old one gets closed.

For feature proposals, list clear, small actionable items so we can track the progress of the change.
### This issue to track progress for FEATURE NAME
- [ ] P1. Title of this piece of the feature (PR link if available)