Skip to content

chore: add issue template to propose new rules #3925

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

Merged
merged 2 commits into from
Oct 3, 2021

Conversation

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @fregante!

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!


🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint. As a thank you, your profile/company logo will be added to our main README which receives thousands of unique visitors per day.

@fregante fregante changed the title Add template to propose new rules chore: Add template to propose new rules Sep 25, 2021
@fregante fregante marked this pull request as ready for review September 26, 2021 05:54
@bradzacher bradzacher added the repo maintenance things to do with maintenance of the repo, and not with code/docs label Sep 26, 2021
@bradzacher
Copy link
Member

This is genius!
I've been meaning to investigate the "issue form" config - so it's great to have an example to work from. We need to change all our templates to these!

I need to have a bit of a think about if we want any additional fields in the template.
I'll get back to this shortly.

@fregante
Copy link
Contributor Author

fregante commented Sep 27, 2021

I've been using forms for a month in a repo and generally I think too many fields are counterproductive, especially if their content is generally mixed together. In some cases I'm thinking about adding a generic "describe your issue" field and then add required checkboxes like:

  • I included the steps to reproduce
  • I included screenshots of the issue, if visual
  • I included console logs, if any

But yeah this varies by repo and requirements

Copy link
Member

@bradzacher bradzacher left a comment

Choose a reason for hiding this comment

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

This is a great start - we can always add more later
Thanks for this!

@bradzacher bradzacher changed the title chore: Add template to propose new rules chore: add issue template to propose new rules Oct 3, 2021
@bradzacher bradzacher merged commit 5a05362 into typescript-eslint:master Oct 3, 2021
@fregante fregante deleted the patch-1 branch October 3, 2021 21:43
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 3, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
repo maintenance things to do with maintenance of the repo, and not with code/docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants