Skip to content
This repository has been archived by the owner on Jun 29, 2022. It is now read-only.

docs/development: add section about codespell #700

Merged
merged 1 commit into from
Jul 8, 2020

Conversation

invidian
Copy link
Member

@invidian invidian commented Jul 3, 2020

Closes #691

Signed-off-by: Mateusz Gozdek mateusz@kinvolk.io

Copy link
Member

@knrt10 knrt10 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR @invidian. Some small change, rest it looks good to me.

docs/development/README.md Outdated Show resolved Hide resolved
docs/development/README.md Outdated Show resolved Hide resolved
docs/development/README.md Outdated Show resolved Hide resolved
docs/development/README.md Outdated Show resolved Hide resolved
docs/development/README.md Outdated Show resolved Hide resolved
docs/development/README.md Outdated Show resolved Hide resolved
docs/development/README.md Outdated Show resolved Hide resolved
docs/development/README.md Outdated Show resolved Hide resolved
docs/development/README.md Outdated Show resolved Hide resolved
docs/development/README.md Outdated Show resolved Hide resolved

To check for typos in commit messages of your feature branch, you can run the following command:
```sh
git diff master..HEAD | grep -v ^- | codespell -
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How does this work? AFAIK git diff doesn't show commit messages.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops, I copied the wrong command from my script 😄 It suppose to be git log master..HEAD | codespell - :)

docs/development/README.md Outdated Show resolved Hide resolved
docs/development/README.md Outdated Show resolved Hide resolved
Closes #691

Signed-off-by: Mateusz Gozdek <mateusz@kinvolk.io>
Copy link
Member

@knrt10 knrt10 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR @invidian. LGTM

Copy link
Contributor

@iaguis iaguis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@knrt10 knrt10 merged commit c1a790b into master Jul 8, 2020
@knrt10 knrt10 deleted the invidian/codespell-docs branch July 8, 2020 09:39
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document working with codespell while developing
3 participants