Improve issue template using Issue forms #2684
Conversation
|
Definitely an improvement over the old template text file system. Listed a few couple minor corrections to your PR in comments above, and while thinking about the issue template at all, realized a few things were outdated, figured I'd just leave them as comments here. If you prefer, I can use the magic github edit-other-peoples-PRs button that apparently exists to apply my suggested changes myself. EDIT: Also a Feature Request template would be good to have as well |
Sure thing. Just need to know what sections you want and what type they should be. |
- Update Paste URL - Make sharing of saves.yml required - Change URL for Spark download - Fix typo for "reproduce"
- Allow blank (empty) issues - Replace warning about dev builds with note to make backups.
|
I've created a Feature request form which you can find here Right now does it have checkboxes you have to tick, a text field to give a description of the idea and an optional text field for possible code. |
| attributes: | ||
| label: 'Code Example' | ||
| description: |- | ||
| If possible, provide a possible Code example for how this could be implemented, or in case of a new API feature, how others could use it. |
There was a problem hiding this comment.
I think this is a bit too technical for all feature requests. Maybe word it to be more optional?
| label: 'I confirm that I have ...' | ||
| description: 'Click the checkboxes to "check" them. Make sure you actually did what they mention.' | ||
| options: | ||
| - label: '...tried the latest [Development Build](https://wiki.citizensnpcs.co/API) to make sure my feature doesn''t exist already.' |
There was a problem hiding this comment.
I'm pretty sure the intended link was https://ci.citizensnpcs.co/job/Citizens2/ not the API wiki page?
|
Thanks! |
Replaces the current
ISSUE_TEMPLATE.mdwith a more advanced (and better looking) Issue form.Additionally adds some common links such as wiki, Discord server, etc. which will be shown when you select the issue template.
A preview of the new issue template can be seen on my fork:
https://github.com/Andre601/Citizens2/blob/feature/add-issue-forms/.github/ISSUE_TEMPLATE/bug_report.yml