Join GitHub today
GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.Sign up
Docs: Propose fix typo for function #9965
What is the purpose of this pull request? (put an "X" next to item)
[ X] Documentation update
What changes did you make? (Give an overview)
Is there anything you'd like reviewers to focus on?
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
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:
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 Yes! Everything looks great now and our commit-message status check is happy
TravisCI and AppVeyor need to rerun due to the forced push, but hopefully those will pass soon enough.