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

chore(release): fix typo in CHANGELOG.md #304

Closed
wants to merge 7 commits into from

Conversation

eltociear
Copy link

Description

seperate -> separate
seperately -> separately

Types of Changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation (no code change)
  • Refactor (refactoring production code)
  • Other

Checklist:

  • My code follows the code style of this project.
  • I have updated the documentation accordingly.
  • I have formatted the code with rustfmt.
  • I checked the lints with clippy.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

seperate -> separate
seperately -> separately
@eltociear eltociear requested a review from orhun as a code owner September 30, 2023 15:50
@welcome
Copy link

welcome bot commented Sep 30, 2023

Thanks for opening this pull request! Please check out our contributing guidelines! ⛰️

@codecov-commenter
Copy link

Codecov Report

All modified lines are covered by tests ✅

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

📢 Thoughts on this report? Let us know!.

@alerque
Copy link
Contributor

alerque commented Sep 30, 2023

Given that

  1. the changelog is auto-generated and
  2. this project is the auto-generator, so not auto-generating it doesn't make much sense, and
  3. git history is immutable (at least in the context of a publicly released code base)

how will manually fixing typos in the changelog that stem from Git commit messages stick?

I presume one could only re-generate future bits, but in my own projects I find it handy to be able to regenerate the whole change log (to update formatting, etc.)

@orhun
Copy link
Owner

orhun commented Oct 1, 2023

Yeah, this won't have an effect since the changelog is being auto-generated every time. You can probably use preprocessors to edit the commit message or postprocessors to tweak the changelog after generation.

@alerque
Copy link
Contributor

alerque commented Oct 2, 2023

Hmm, a preprocessor that fixes up egregious spelling mistakes that are cemented in Git history for all developers to see but you'd rather not have turn up in the more public facing changelog does sound like a reasonable approach.

@orhun
Copy link
Owner

orhun commented Oct 9, 2023

Hey @eltociear, are you going to follow up on this?

@orhun orhun mentioned this pull request Oct 10, 2023
@orhun
Copy link
Owner

orhun commented Oct 19, 2023

Fixed in #316

@orhun orhun closed this Oct 19, 2023
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.

4 participants