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: Propose fix typo for function #9965

Merged
merged 1 commit into from Feb 9, 2018
Merged

Conversation

@jeis2497052
Copy link
Contributor

jeis2497052 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)

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

@jsf-clabot

This comment has been minimized.

Copy link

jsf-clabot commented Feb 9, 2018

CLA assistant check
All committers have signed the CLA.

@eslint eslint bot added the triage label Feb 9, 2018
@abiduzz420

This comment has been minimized.

Copy link
Contributor

abiduzz420 commented Feb 9, 2018

Hello @jeis2497052
You need to follow the commit-message guidelines. The check failed because the commit message did not start with label Docs: . Also edit the PR title. Example: Docs: Propose fix typo for function

@jeis2497052

This comment has been minimized.

Copy link
Contributor Author

jeis2497052 commented Feb 9, 2018

Sorry, can I repair this PR or start again?

@jeis2497052

This comment has been minimized.

Copy link
Contributor Author

jeis2497052 commented Feb 9, 2018

Not sure if or how to repair?

@abiduzz420

This comment has been minimized.

Copy link
Contributor

abiduzz420 commented Feb 9, 2018

PR title could be directly edited from the UI. For making changes to the commit message, you could take the help of this: https://help.github.com/articles/changing-a-commit-message/

EDIT: If you need additional help, here it is

1. Type git commit --amend
2. Enter the commit message: Docs: Propose fix typo for function
3. git push --force origin master
@jeis2497052 jeis2497052 changed the title Propose fix typo for function Doc: Propose fix typo for function Feb 9, 2018
@jeis2497052 jeis2497052 changed the title Doc: Propose fix typo for function Docs: Propose fix typo for function Feb 9, 2018
@jeis2497052

This comment has been minimized.

Copy link
Contributor Author

jeis2497052 commented Feb 9, 2018

is the UI edit OK now with Docs: added?

@platinumazure

This comment has been minimized.

Copy link
Member

platinumazure commented Feb 9, 2018

Hi @jeis2497052, thanks for contributing!

Our commit message check will look at either the first commit's commit message, or the PR title, depending on the number of commits in the PR. If the PR has 1 commit, we look at the commit message; if 2 or more, we look at the PR title. This is because GitHub's squash and merge interface uses the exact same logic to decide what commit message to suggest when we are about to merge.

Right now, your PR title matches our guidelines, but the commit message does not, and there is only one commit.

I think we could handle this using one of the following approaches:

  1. Ignore the issue, and we'll make sure the commit message matches the PR title on merge
  2. You could find another thing to change (ideally in the same file) and push another commit, which will then make our commit message check look at the PR title
  3. You could use git commit --amend, then git push (remote-name) (branch-name) -f, as suggested by @abiduzz420.

The last option is probably the "best" option, but also the most annoying on your end. Let me know how you would like to proceed.

@jeis2497052 jeis2497052 force-pushed the jeis2497052:master branch from 8eb5a9e to 5f21449 Feb 9, 2018
@jeis2497052

This comment has been minimized.

Copy link
Contributor Author

jeis2497052 commented Feb 9, 2018

Did I properly amend ?

@platinumazure

This comment has been minimized.

Copy link
Member

platinumazure commented Feb 9, 2018

@jeis2497052 Yes! Everything looks great now and our commit-message status check is happy 😄 Thanks so much for taking the time to do this, it really helps us out and it makes our changelog beautiful.

TravisCI and AppVeyor need to rerun due to the forced push, but hopefully those will pass soon enough.

@ilyavolodin

This comment has been minimized.

Copy link
Member

ilyavolodin commented Feb 9, 2018

Thanks for the pull request.

@ilyavolodin ilyavolodin merged commit 777283b into eslint:master Feb 9, 2018
5 checks passed
5 checks passed
commit-message Commit message follows guidelines
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
licence/cla Contributor License Agreement is signed.
Details
release-monitor No patch release is pending
Details
@renovate renovate bot mentioned this pull request Feb 16, 2018
@renovate renovate bot mentioned this pull request Mar 23, 2018
@@ -20,7 +20,7 @@ Examples of **incorrect** code for this rule:
typeof foo === "strnig"
typeof foo == "undefimed"
typeof bar != "nunber"
typeof bar !== "fucntion"
typeof bar !== "function"

This comment has been minimized.

Copy link
@Wilfred

Wilfred Jun 5, 2018

Contributor

@platinumazure @jeis2497052 I think this is wrong. These are deliberate typos, aren't they?

This comment has been minimized.

Copy link
@not-an-aardvark

not-an-aardvark Jun 5, 2018

Member

Agreed, would you like to create a PR to fix this example?

This comment has been minimized.

Copy link
@Wilfred
Wilfred added a commit to Wilfred/eslint that referenced this pull request Jun 9, 2018
This was accidentally removed in eslint#9965.
Wilfred added a commit to Wilfred/eslint that referenced this pull request Jun 9, 2018
This was accidentally removed in eslint#9965.
platinumazure added a commit that referenced this pull request Jun 9, 2018
This was accidentally removed in #9965.
@eslint eslint bot locked and limited conversation to collaborators Aug 9, 2018
@eslint eslint bot added the archived due to age label Aug 9, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

7 participants
You can’t perform that action at this time.