Skip to content

fixes yaml example #1350

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

Merged
merged 1 commit into from
Feb 1, 2025
Merged

fixes yaml example #1350

merged 1 commit into from
Feb 1, 2025

Conversation

mvhirsch
Copy link
Contributor

@mvhirsch mvhirsch commented Jan 31, 2025

Description

Fixes documentation typos.

Checklist

  • Add test cases to all the changes you introduce
  • Run ./scripts/format and ./scripts/test locally to ensure this change passes linter check and test
  • Test the changes on the local machine manually
  • Update the documentation for the changes

Expected behavior

n/A

Steps to Test This Pull Request

n/A

Additional context

n/A

@Lee-W
Copy link
Member

Lee-W commented Jan 31, 2025

Description

Fixes documentation typos.

Checklist

* [ ]  ~Add test cases to all the changes you introduce~

* [ ]  ~Run `./scripts/format` and `./scripts/test` locally to ensure this change passes linter check and test~

* [ ]  ~Test the changes on the local machine manually~

* [x]  Update the documentation for the changes

Expected behavior

n/A

Steps to Test This Pull Request

n/A

Additional context

n/A

Hi, thanks for fixing the typo. we need to follow the commit rule to pass the CI. could you please modify it? thanks!

@mvhirsch
Copy link
Contributor Author

Like this @Lee-W ?

@Lee-W
Copy link
Member

Lee-W commented Feb 1, 2025

hmm... I am not sure what you changed. but I can take over and fix the commit issue. Thanks!

Copy link

codecov bot commented Feb 1, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.55%. Comparing base (120d514) to head (721191b).
Report is 547 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1350      +/-   ##
==========================================
+ Coverage   97.33%   97.55%   +0.21%     
==========================================
  Files          42       55      +13     
  Lines        2104     2614     +510     
==========================================
+ Hits         2048     2550     +502     
- Misses         56       64       +8     
Flag Coverage Δ
unittests 97.55% <ø> (+0.21%) ⬆️

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.

@Lee-W Lee-W merged commit 5d6369e into commitizen-tools:master Feb 1, 2025
18 checks passed
@mvhirsch
Copy link
Contributor Author

mvhirsch commented Feb 1, 2025

hmm... I am not sure what you changed. but I can take over and fix the commit issue. Thanks!

Thank you. I see, my commit message was still wrong!

I'm new to this project and just tried and played around. I found these typos and just quickly fixed them using Githubs UI. I were unable to identify any contribution guidelines (either by CONTRIBUTING.md nor documentation) easily. @Lee-W are there any contribution guidelines highlighting this?

@mvhirsch mvhirsch deleted the patch-1 branch February 1, 2025 09:14
@Lee-W
Copy link
Member

Lee-W commented Feb 1, 2025

hmm... I am not sure what you changed. but I can take over and fix the commit issue. Thanks!

Thank you. I see, my commit message was still wrong!

I'm new to this project and just tried and played around. I found these typos and just quickly fixed them using Githubs UI. I were unable to identify any contribution guidelines (either by CONTRIBUTING.md nor documentation) easily. @Lee-W are there any contribution guidelines highlighting this?

No worries 🙂 Yep, it's in the docs https://commitizen-tools.github.io/commitizen/contributing/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment