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

Docs: add code fences to the issue template #7254

Merged

Conversation

not-an-aardvark
Copy link
Member

What is the purpose of this pull request? (put an "X" next to item)

[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:

Please check each item to ensure your pull request is ready:

  • I've read the pull request guide
  • (n/a) I've included tests for my change
  • I've updated documentation for my change (if appropriate)

What changes did you make? (Give an overview)

There have been a few cases (e.g. #7164 and #7251) where people have pasted source code into the issue template without putting it in a code block. This can make it confusing to look at the issue, because markdown hides all indentation and HTML-like tags.

This PR adds a code block to the issue template to encourage people to put their source code/configs in code blocks.

Is there anything you'd like reviewers to focus on?

Nothing in particular, but I'm certainly open to bikeshedding on the wording/formatting.

@mention-bot
Copy link

@not-an-aardvark, thanks for your PR! By analyzing the annotation information on this pull request, we identified @kaicataldo, @nzakas and @platinumazure to be potential reviewers

@eslintbot
Copy link

LGTM

@vitorbal vitorbal added the documentation Relates to ESLint's documentation label Sep 27, 2016
Copy link
Member

@vitorbal vitorbal left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks!

@ilyavolodin ilyavolodin merged commit 722c68c into eslint:master Sep 27, 2016
@not-an-aardvark not-an-aardvark deleted the issue-template-code-fences branch March 23, 2017 16:22
@eslint-deprecated eslint-deprecated bot locked and limited conversation to collaborators Feb 6, 2018
@eslint-deprecated eslint-deprecated bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Feb 6, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
archived due to age This issue has been archived; please open a new issue for any further discussion documentation Relates to ESLint's documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants