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: clean up key-spacing docs (fixes #9900) #9963

merged 4 commits into from Feb 10, 2018

Docs: clean up key-spacing docs (fixes #9900) #9963

merged 4 commits into from Feb 10, 2018


Copy link

@abiduzz420 abiduzz420 commented Feb 9, 2018

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:

What changes did you make? (Give an overview)
Categorized key-spacing options based on their values.

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

Copy link

@platinumazure platinumazure commented Feb 9, 2018

Hi @abiduzz420, thanks for the PR!

Just a quick summary of what the failed status checks mean:

  • AppVeyor/Travis: Our Markdown linting prefers that we use 4 spaces for indenting sub-lists; I see 2 spaces in this PR. There may be other issues, so please take a look at the "Details" links for those two status checks to see if there's anything else.
  • commit-message: The commit message should start with a tag, like "Docs:". Also, we prefer that the message ends with "(fixes #9900)", just so the commit messages look uniform in our changelog.

Once you have 2 or more commits in a pull request, we check the PR title in the commit-message check. So my suggestion would be to push a 2nd commit to fix the Markdown lint issues, and then change the PR title to fix the commit-message check.

Thanks for your understanding!

@abiduzz420 abiduzz420 changed the title clean up key-spacing doc.(#9900) Docs: clean up key-spacing docs (fixes #9900) Feb 9, 2018
Copy link

@platinumazure platinumazure left a comment

LGTM, thanks! I'd like to wait for one more review before merging.

@not-an-aardvark not-an-aardvark merged commit 426868f into eslint:master Feb 10, 2018
5 checks passed
Copy link

@not-an-aardvark not-an-aardvark commented Feb 10, 2018

Thanks for contributing!

@eslint-deprecated eslint-deprecated bot locked and limited conversation to collaborators Aug 10, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

4 participants