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

Add issue templates #2355

Merged
merged 2 commits into from
Oct 2, 2024
Merged

Add issue templates #2355

merged 2 commits into from
Oct 2, 2024

Conversation

penelopeysm
Copy link
Member

@penelopeysm penelopeysm commented Sep 29, 2024

Description

GitHub has a nice feature for issue templates, which basically mean that people submitting an issue do it by filling in a form rather than providing freeform text.

This has a couple of benefits:

  1. We can explicitly require people to provide an MWE as well as the info needed to reproduce their bug (i.e. manifest and version info). Not having this info is annoying.

  2. Issues added via this form should be automatically added to our project board. (See Adding new issues and PRs to Project Board automatically.  #2315) Only happens if the issue is opened by someone who already has write access to the project board.

This PR adds two templates - one for bug reports and one for 'anything else', which is mostly blank. In theory we could have a feature request one too, although I don't think that a feature request template would substantially differ from 'anything else'.

It also adds a config file which disables blank issues (i.e., it forces people to use the templates).

Preview the changes

To have a peek at what this would look like, I've added the same issue template to a playground repository of mine: https://github.com/penelopeysm/Shaymin.jl/issues Feel free to create an issue there and see the output. Note: on this repository blank issues are still permitted (blue circle below). This is just to let you see what that looks like. I've disabled the option in this PR.

Screenshot 2024-09-29 at 02 37 25

The rest of the organisation

If we like how this works, then I propose we add the same templates to other repos in TuringLang too, which (should) accomplish our aim of issues across the organisation being added to the project board.

Copy link

codecov bot commented Sep 29, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.80%. Comparing base (3c91eec) to head (75e60d3).

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2355      +/-   ##
==========================================
- Coverage   86.86%   86.80%   -0.07%     
==========================================
  Files          24       24              
  Lines        1599     1599              
==========================================
- Hits         1389     1388       -1     
- Misses        210      211       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@coveralls
Copy link

coveralls commented Sep 29, 2024

Pull Request Test Coverage Report for Build 11135548416

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage decreased (-0.06%) to 87.022%

Totals Coverage Status
Change from base Build 11050401755: -0.06%
Covered Lines: 1388
Relevant Lines: 1595

💛 - Coveralls

Copy link
Member

@torfjelde torfjelde left a comment

Choose a reason for hiding this comment

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

I'm very much in favour of this:) Dopey stuff @penelopeysm

Copy link
Member

@mhauru mhauru left a comment

Choose a reason for hiding this comment

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

I like it, especially getting issues on the board automatically. A bit unsure about whether to disable blank issues. I guess the Anything Else template is very simple, and explicitly says version info is optional.

@penelopeysm
Copy link
Member Author

Yeah, I'm kind of unsure about that too. I don't really have any problem with blank issues in and of themselves, it's just that it's less "complete" since blank issues won't get added to the project board.

@torfjelde
Copy link
Member

IIUC there's no difference between the "Anything else" and the "blank issue" right? Other than being added to the board?

@penelopeysm
Copy link
Member Author

penelopeysm commented Sep 30, 2024

@torfjelde Without <details>, with <details> I do like the latter 🙂

@penelopeysm
Copy link
Member Author

penelopeysm commented Oct 2, 2024

Of course, it's never as good as one expects:

Note: The person opening the issue must have write permissions for the specified projects.

https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms

So the issue won't be added to the project board unless it's basically one of us opening the issue. But I suppose it's still a useful way to guide people submitting bugs.

In view of this, I've re-enabled blank issues and removed 'anything else' as it means there's one less template to maintain.

I'll also look into a separate way of auto-adding issues.

@penelopeysm penelopeysm merged commit b1122c1 into master Oct 2, 2024
59 of 60 checks passed
@penelopeysm penelopeysm deleted the py/issue-template branch October 2, 2024 19:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants