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

docs(config): fix typo in comment of default config file #776

Merged
merged 1 commit into from
Jul 30, 2024

Conversation

myl7
Copy link
Contributor

@myl7 myl7 commented Jul 30, 2024

Description

This PR changes the comment of the header field in the default cliff.toml config, from # template for the changelog footer to # template for the changelog header.

Motivation and Context

That field is for headers so footer in the comment seems to be a typo.

How Has This Been Tested?

As a change to comments, no tests are required.

Screenshots / Logs (if applicable)

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.

@myl7 myl7 requested a review from orhun as a code owner July 30, 2024 12:22
Copy link

welcome bot commented Jul 30, 2024

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

@codecov-commenter
Copy link

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 36.40%. Comparing base (35dc1e4) to head (c67c432).

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

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #776   +/-   ##
=======================================
  Coverage   36.40%   36.40%           
=======================================
  Files          20       20           
  Lines        1522     1522           
=======================================
  Hits          554      554           
  Misses        968      968           
Flag Coverage Δ
unit-tests 36.40% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Owner

@orhun orhun left a comment

Choose a reason for hiding this comment

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

thanks!

@orhun orhun merged commit e2fb043 into orhun:main Jul 30, 2024
55 checks passed
Copy link

welcome bot commented Jul 30, 2024

Congrats on merging your first pull request! ⛰️

@myl7 myl7 deleted the config branch July 30, 2024 18:34
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.

3 participants