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(changelog): add commitizen template #356

Merged
merged 1 commit into from
Feb 13, 2024

Conversation

kenibrewer
Copy link
Member

@kenibrewer kenibrewer commented Nov 7, 2023

Description

This change adds a commitizen CHANGELOG template that includes a link to the detailed GitHub release notes.
It also adds some clarifications for the release process documentation.

What is the nature of your change?

  • Enhancement (adds functionality).
  • This change requires a documentation update.

Checklist

Please ensure that all boxes are checked before indicating that a pull request is ready for review.

  • I have read the CONTRIBUTING.md guidelines.
  • My code follows the style guidelines of this project.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • I have deleted all non-relevant text in this pull request template.

@kenibrewer kenibrewer force-pushed the docs/changelog-template branch from 84e4b08 to 6fbd430 Compare November 7, 2023 14:34
@codecov-commenter
Copy link

codecov-commenter commented Nov 7, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (94a2ae7) 95.01% compared to head (f3ed05c) 95.01%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #356   +/-   ##
=======================================
  Coverage   95.01%   95.01%           
=======================================
  Files          56       56           
  Lines        3187     3187           
=======================================
  Hits         3028     3028           
  Misses        159      159           
Flag Coverage Δ
unittests 95.01% <ø> (ø)

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.

@kenibrewer kenibrewer requested a review from d33bs December 18, 2023 22:11
Copy link
Member

@d33bs d33bs left a comment

Choose a reason for hiding this comment

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

Nice stuff @kenibrewer ! I left a few comments I wanted to get your feedback on before an approval but overall I thought things looked good. Please don't hesitate to let me know if you have any questions.

CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
dev_tools/commitizen/CHANGELOG.md.j2 Outdated Show resolved Hide resolved
dev_tools/commitizen/CHANGELOG.md.j2 Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
This change adds a commitizen CHANGELOG template that includes a link to the detailed GitHub release notes.

Co-authored-by: Dave Bunten <dave.bunten@cuanschutz.edu>
@kenibrewer kenibrewer force-pushed the docs/changelog-template branch from 6fbd430 to f3ed05c Compare February 12, 2024 11:03
@kenibrewer kenibrewer requested a review from d33bs February 12, 2024 11:04
Copy link
Member

@d33bs d33bs left a comment

Choose a reason for hiding this comment

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

Thanks @kenibrewer for your updates and responses! LGTM

dev_tools/commitizen/CHANGELOG.md.j2 Show resolved Hide resolved
@kenibrewer kenibrewer merged commit cfd0852 into cytomining:main Feb 13, 2024
9 checks passed
@kenibrewer kenibrewer deleted the docs/changelog-template branch February 13, 2024 07:42
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