progit / progit2

Pro Git 2nd Edition
Other
5.79k stars 1.9k forks source link

Migrate templates to forms #1687

Closed HonkingGoose closed 3 years ago

HonkingGoose commented 3 years ago

Changes

Context

šŸšØ I'm using a beta feature here, things break on us somehow later on, so be aware of that. šŸšØ

GitHub has released a new feature: Issue Forms. This makes filling out the issue (properly) a lot easier. On the maintainer side, life will be a bit better as well, as we can now enforce that certain fields are properly filled out. Sadly this new feature is not available for pull requests.

I've made new forms for you that replicate what we use now. The bug report form is way too big. I'd like to take this opportunity to limit the amount of checksboxes/fields if at all possible. šŸ˜‰

Here's how you can view my work:

  1. Go to https://github.com/HonkingGoose/progit2/tree/migrate-to-forms/.github/ISSUE_TEMPLATE
  2. Click on the new bug_report.yml and/or the enhancement_idea.yml file.
  3. After you click on the file, GitHub will show a preview in the browser.

If you want to try out the forms for real, I can put this on a throwaway repository so you can actually use the templates in the way a user would. Let me know if you want me to do this or not. šŸ˜‰

Relevant GitHub docs:

ben commented 3 years ago

Looks great! I say we give it a try, so long as you can bypass and create an issue free-form so people can tell us if it's broken. šŸ˜

HonkingGoose commented 3 years ago

@ben I'm glad you like the idea!

I've pushed a commit that allows blank issues, for now. I do intend to remove this "escape hatch" once the forms feature is fully release in a stable version by GitHub. As having the escape hatch kind of defeats the point of having the locked down forms... šŸ˜‰

This is ready for the final review/merge then.

If anybody wants me to make adjustments, please make a new issue to discuss the changes you need, and I'll make a PR with the changes. šŸ˜‰