Skip to content

Conversation

@bearomorphism
Copy link
Contributor

Documentation Changes

  • Run poetry doc locally to ensure the documentation pages renders correctly
  • Check and fix any broken links (internal or external) in the documentation

@codecov
Copy link

codecov bot commented Nov 20, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.68%. Comparing base (120d514) to head (e11ebbc).
⚠️ Report is 848 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1664      +/-   ##
==========================================
+ Coverage   97.33%   98.68%   +1.34%     
==========================================
  Files          42       60      +18     
  Lines        2104     2656     +552     
==========================================
+ Hits         2048     2621     +573     
+ Misses         56       35      -21     
Flag Coverage Δ
unittests 98.68% <ø> (+1.34%) ⬆️

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.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@woile
Copy link
Member

woile commented Nov 21, 2025

Can we call them differently? I don't think they are "templates", and templates already fill another roll.
What about "conventions", "rules", or something else?

@bearomorphism
Copy link
Contributor Author

I'd prefer calling them "rules" or "plugins" to distinguish them from changelog templates.

These third party projects contain data about commit validation rules, commit generation process, bump rules, etc. I agree the name "template" is a bit misleading.

We can add a historical note to point out that such things are called "templates" before this PR.

@bearomorphism
Copy link
Contributor Author

image

Name of the committing rules to use.

In this page, it is also called "rules"

@woile
Copy link
Member

woile commented Nov 21, 2025

If we want to be specific, I think the best would be to start calling them: "conventions".

Teams, people or organizations develop "commit convetions", I don't think "rules", nor "templates" are adequate.
At least, that's what makes sense to me. I would search for "conventions", not "templates".
And yes, they are installed as "plugins" [0]

Keep in mind, that this split, doesn't take into account the fact that you can publish a "convention", a "provider", a "changelog_format" and a "scheme" all under the same package. commitizen itself is an example of this [1]

Maybe it would make more sense to have:
"Third party plugins"
And for each plugging, we document what do they provide:

  • a convention
  • a scheme
  • a provider
  • a changelog_format

or all of them

@bearomorphism
Copy link
Contributor Author

Sounds good.

@bearomorphism bearomorphism marked this pull request as draft November 21, 2025 09:51
@bearomorphism bearomorphism force-pushed the doc-third-party branch 2 times, most recently from 3262f88 to e420d5b Compare November 21, 2025 17:40
@bearomorphism bearomorphism marked this pull request as ready for review November 21, 2025 17:40
@bearomorphism bearomorphism force-pushed the doc-third-party branch 4 times, most recently from 0756a66 to 75e43ba Compare November 21, 2025 17:51
@bearomorphism
Copy link
Contributor Author

And for each plugging, we document what do they provide:

For this part, I added some TODOs and we can have future contributors to address the missing content issue. (I would not like to look into what features the plugin provides for each plugin. If I do so, there will be likely inaccurate information which is worse than missing content, and it is also hard for reviewers to spot the misinformation in this PR)

Now this PR is ready for review.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants