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: Update capitalized-comments with missing letters (fixes #10135) #10134

Merged
merged 1 commit into from Mar 28, 2018

Conversation

Projects
None yet
4 participants
@jasonfry
Contributor

jasonfry commented Mar 28, 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)
Added d to the end of capitalize to make it capitalized in two places.

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

@jsf-clabot

This comment has been minimized.

jsf-clabot commented Mar 28, 2018

CLA assistant check
All committers have signed the CLA.

@eslint eslint bot added the triage label Mar 28, 2018

@jasonfry jasonfry changed the title from Update capitalized-comments with missing letters to Docs - changes to documentation only.Update capitalized-comments with missing letters Mar 28, 2018

@jasonfry jasonfry changed the title from Docs - changes to documentation only.Update capitalized-comments with missing letters to Docs - Update capitalized-comments with missing letters Mar 28, 2018

@jasonfry jasonfry changed the title from Docs - Update capitalized-comments with missing letters to Docs - Update capitalized-comments with missing letters (fixes #10135) Mar 28, 2018

@jasonfry jasonfry changed the title from Docs - Update capitalized-comments with missing letters (fixes #10135) to Docs: Update capitalized-comments with missing letters (fixes #10135) Mar 28, 2018

@platinumazure

This comment has been minimized.

Member

platinumazure commented Mar 28, 2018

Hi @jasonfry, thanks for the PR!

The commit-message check is complaining because while the PR title now follows our message guidelines, the commit message hasn't changed (and GitHub's squash-and-merge algorithm suggests the original commit message as the merge commit message when the PR has only one commit in it).

If you made the change on your own computer and pushed to your GitHub fork, you could fix this by using git commit --amend and then git push origin patch-1 --force to get a commit with a new message up. If you made the change using GitHub's interface, though, that might be more of a pain (I don't know if GitHub will let you amend commit messages, I'm thinking no). So please let me know if you think you can change the commit message on your end, otherwise I'll just use the PR title when I merge here.

Thanks for contributing, we really appreciate it!

@platinumazure

Changes LGTM, thanks!

@jasonfry

This comment has been minimized.

Contributor

jasonfry commented Mar 28, 2018

Hi @platinumazure, I made the changes via github and yup, I cannot see a way to change the commit message.

@platinumazure platinumazure merged commit 9c79174 into eslint:master Mar 28, 2018

4 of 5 checks passed

commit-message Commit message doesn't follow 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
@platinumazure

This comment has been minimized.

Member

platinumazure commented Mar 28, 2018

No worries @jasonfry, it happens. I've merged with an altered commit message this time.

Our full pull request guide can be found here, and our commit message guide is in this section. The reason we like to have commit messages formatted a certain way is that it makes our release changelogs look uniform, and also allows our release machinery to auto-format release blog posts with changes broken out by type. So we really appreciate it when people follow the commit message guidelines, it helps us out a lot.

Thanks again for contributing, and I hope to see you again in the future!

@jasonfry jasonfry deleted the jasonfry:patch-1 branch Mar 28, 2018

@eslint eslint bot locked and limited conversation to collaborators Sep 25, 2018

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.