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

feat: add commitizen cli and commit standards #340

Merged
merged 3 commits into from
Oct 29, 2023

Conversation

kenibrewer
Copy link
Member

@kenibrewer kenibrewer commented Oct 27, 2023

Description

Commitizen pre-installed cli will aid in the generation of commit messages can be used for automatic changelog generation.

Address #333

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 requested a review from d33bs October 27, 2023 16:02
@codecov-commenter
Copy link

codecov-commenter commented Oct 27, 2023

Codecov Report

Merging #340 (cd6ef6b) into main (7b97db7) will not change coverage.
Report is 2 commits behind head on main.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #340   +/-   ##
=======================================
  Coverage   95.40%   95.40%           
=======================================
  Files          56       56           
  Lines        3135     3135           
=======================================
  Hits         2991     2991           
  Misses        144      144           
Flag Coverage Δ
unittests 95.40% <ø> (ø)

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

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

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 work! These were thoughtful additions and appreciate the additional context in the PR description. I left a few comments which I hope to get your feedback on before an approval. Mostly here I wonder / worry about what happens with squashes and those who might be new to the procedures (and also might be developing locally instead of in the devcontainer).

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
.pre-commit-config.yaml Outdated Show resolved Hide resolved
@kenibrewer kenibrewer changed the title feat: add commitizen cli and hooks feat: add commitizen cli and commit standards Oct 28, 2023
Commitizen cli will aid in commit formatting and changelog generation

Address cytomining#333
@kenibrewer
Copy link
Member Author

@d33bs I made the following changes since your last review:

  • Went back to installing commitizen via poetry dev group. It turns out the previously used dev container feature is from an identically named (but separate) commitzen project from the js community. I took a closer look at the version restrictions I was worried about, but the relevant packages only moved back a few months from the latest version. Commitizen is also under active development so I'm less worried about the impacts.
  • Removed the commitizen precommit hook for further discussion and possible integration post 1.0.
  • Modifed the language about formatting to be dev environment agnostic.

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 for the replies and follow up comments - LGTM.

@kenibrewer kenibrewer merged commit c328335 into cytomining:main Oct 29, 2023
10 checks passed
@kenibrewer kenibrewer deleted the feat/changelog branch October 29, 2023 03:01
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