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

git-commit.el: Fix typo #5141

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

git-commit.el: Fix typo #5141

wants to merge 1 commit into from

Conversation

ideapark
Copy link
Contributor

@ideapark ideapark commented May 13, 2024

WIP, DO NOT MERGE.

Signed-off-by: Park Zhou <ideapark@petalmail.com>
@tarsius
Copy link
Member

tarsius commented May 13, 2024

Thanks again!

So it appears you are reading the source and are running into typos along the way. That isn't unexpected and I appreciative the fixes. I did not merge your previous pr as quickly as the first, because I expected that you would keep providing more fixes as you go, hoping you would just push additional commits to the open pull-request. Please do that going forward. Fixing these mistakes is nice but it is not important, that each fix hits the main branch as quickly as possible, and it is less work for both of us, if we don't have to deal with a pull-request per typo.

@tarsius
Copy link
Member

tarsius commented May 14, 2024

Some notes about commit messages:

  • We don't use "signed-off-by" or similar trailers. I usually leave them in place if a contributor uses them, but when I also make some change to the patch or commit message, that makes me a bit uneasy, because depending on one's definition of what is being signed off, that makes that statement untrue.
  • We only use "some-file: Do things" for changes that concern that file as a whole, like "foo.el: New library".
  • I am a bit inconsistent when it comes to commit message about typo fixes, making harder for contributors to pick up on a style. But here's some examples I would use.
    • some-function: Fix docstring typos
    • manual: Fix typos
    • docs: Fix typos [When typos are fixed in both docstrings and the manual]
    • Fix docstring typos [Multiple unrelated typos in multiple more or less related docstrings]

@ideapark
Copy link
Contributor Author

Thanks for your explaination, I will follow your instructions.

@ideapark ideapark changed the title git-commit.el: Fix typo WIP: git-commit.el: Fix typo May 21, 2024
@ideapark ideapark marked this pull request as draft May 21, 2024 02:22
@ideapark ideapark changed the title WIP: git-commit.el: Fix typo git-commit.el: Fix typo May 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants