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

[workflow] Update issue templates #1794

Merged
merged 7 commits into from
Sep 7, 2020
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
21 changes: 18 additions & 3 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,24 @@ assignees: ''
A clear and concise description of what the bug is, ideally within 20 words.

**To Reproduce**
Please post a sample code to reproduce the bug. The developer team will put a higher priority on bugs that can be reproduced within 20 lines of code. If you want a prompt reply, please keep the code short.
Please post a **minimal sample code** to reproduce the bug.
The developer team will put a higher priority on bugs that can be reproduced within 20 lines of code. If you want a prompt reply, please keep the sample code **short** and **representative**.

```py
# sample code here
```

**Log/Screenshots**
Please post the full log of the program (instead of just a few lines around the error message, unless the log is > 1000 lines). This will help us diagnose what's happening.
Please post the **full log** of the program (instead of just a few lines around the error message, unless the log is > 1000 lines). This will help us diagnose what's happening. For example:

```
$ python my_sample_code.py
[Taichi] mode=release
[Taichi] version 0.6.29, llvm 10.0.0, commit b63f6663, linux, python 3.8.3
...
```

**Additional comments**
If possible, please also consider attach the output of command `ti diagnose` for obtaining detailed environment informations to help us diagnose.
archibate marked this conversation as resolved.
Show resolved Hide resolved

**If you have local commits (e.g. compile fixes before you reproduce the bug), please make sure you first make a PR to fix the build errors and then report the bug.**
If you have local commits (e.g. compile fixes before you reproduce the bug), please make sure you first make a PR to fix the build errors and then report the bug.
9 changes: 9 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Ref: https://github.com/pypa/pypi-support/blob/master/.github/ISSUE_TEMPLATE/config.yml
blank_issues_enabled: true
contact_links:
- name: Contributor Guideline
url: https://taichi.readthedocs.io/en/latest/contributor_guide.html
about: Please check this out if you'd like to contribute by opening a PR :)
- name: Taichi Forum
url: https://forum.taichi.graphics
about: GitHub issues too formal? Question about Taichi? Feel free to ask via our forum!
archibate marked this conversation as resolved.
Show resolved Hide resolved
15 changes: 13 additions & 2 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,22 @@ assignees: ''
---

**Concisely describe the proposed feature**
A clear and concise description of what you want. For example,
> I would like to add an Apple Metal backend to the compiler so that my Macbook GPU can be utilized.
A clear and concise description of what you want. For example:

I would like to add an Apple Metal backend to the compiler so that my Macbook GPU can be utilized.

**Think about the advantages and disadvantages of the proposed feature**
All coins have its two side, we encourage people to thinking critically. For example:
archibate marked this conversation as resolved.
Show resolved Hide resolved

Advantages:
1. So that Apple users could utilize their GPU resources.

Disadvantages:
1. Increases the maintainance cost over multiple backends.

**Describe the solution you'd like (if any)**
A clear and concise description of what you want to achieve and implement.
You may also describe an alternative solution you've thought (if any).
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
You may also describe an alternative solution you've thought (if any).

Sorry but I don't understand this - do you want the issue opener to describe a second solution?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yes, better expressions?


**Additional comments**
Add any other context or screenshots about the feature request here.
3 changes: 2 additions & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
Related issue = #

<!--
Thanks for your PR!
If it's your first time contributing to Taichi, please make sure you have read our Contributor Guideline:
Expand All @@ -16,7 +18,6 @@ If it's your first time contributing to Taichi, please make sure you have read o
- So that when the PR gets merged, GitHub will **automatically** close the issue #2345 for you.
- If the PR doesn't belong to any existing issue, and it's a trivial change, feel free to leave it blank :)
-->
Related issue = #

[[Click here for the format server]](http://kun.csail.mit.edu:31415/)

Expand Down
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -74,4 +74,3 @@ _build
*.ptx
*.ll
*.bc
*.yml
Copy link
Member

Choose a reason for hiding this comment

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

What's the reason for removing this? Asking because action recording could produce yml files (which IMO should be ignored).

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

.travis.yml, appveyor.yml, etc. There're too many files involving yml. For example, I added .github/workflows/some_new_workflow.yml, and find it's not added because of .gitignore.
FYI I use .gitignore_localrc for ignoring these outputs.

Copy link
Member

Choose a reason for hiding this comment

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

Ah I see

Copy link
Member

Choose a reason for hiding this comment

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

I believe we should keep ignoring *.yml files. Most of these should not be added automatically.
You can always use git add --force for exceptions.
Please revert this change if that makes sense.