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.

Sign up for GitHub

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

Jump to bottom

Fix typos in the changelog #310

Closed
orhun opened this issue Oct 10, 2023 · 1 comment · Fixed by #316
Closed

Fix typos in the changelog #310

orhun opened this issue Oct 10, 2023 · 1 comment · Fixed by #316
Assignees
@woshilapin
Labels
good first issue Good for newcomers

Comments

@orhun
Copy link
Owner

orhun commented Oct 10, 2023

Is your feature request related to a problem? Please describe.

There are some typos in the changelog and it would be nice to fix them.

Unfortunately we can't just push a commit to fix them since the changelog is re-generated with each release.

Describe the solution you'd like

  1. Spot the typo commits with typos or codespell.
  2. Update the default changelog configuration for pre-processing the commit messages.

Describe alternatives you've considered

Or use post-processors to update the final changelog.

Additional context

There is already a PR for this at #304 but seems inactive.
@orhun orhun added the good first issue Good for newcomers label Oct 10, 2023
@orhun orhun self-assigned this Oct 10, 2023
@orhun orhun mentioned this issue Oct 10, 2023
Closed
@woshilapin
Copy link
Contributor

woshilapin commented Oct 15, 2023 •
edited
Loading

Hey there, I'd like to work on that one (and #311 at the same time) if that's ok.

woshilapin added a commit to woshilapin/git-cliff that referenced this issue Oct 15, 2023
@woshilapin
docs(changelog): fix typos
15e2226 
fixes orhun#310
woshilapin added a commit to woshilapin/git-cliff that referenced this issue Oct 15, 2023
@woshilapin
docs(changelog): fix typos
fc08f81 
fixes orhun#310
@woshilapin woshilapin mentioned this issue Oct 15, 2023
Merged
12 tasks
@orhun orhun assigned woshilapin and unassigned orhun Oct 15, 2023
woshilapin added a commit to woshilapin/git-cliff that referenced this issue Oct 16, 2023
@woshilapin
docs(changelog): fix typos
cd0cb88 
fixes orhun#310
orhun pushed a commit that referenced this issue Oct 19, 2023
@woshilapin @mergify
docs(changelog): fix typos (#316)
edd3c30 
* docs(changelog): fix typos

fixes #310

* docs(release): explain how typos are auto-corrected

* feat(ci): check/install 'typos' for release

---------

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@woshilapin woshilapin

Labels
good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs(changelog): fix typos woshilapin/git-cliff
2 participants
@woshilapin @orhun