-
-
Notifications
You must be signed in to change notification settings - Fork 301
docs(third-party): separate providers and template docs #1664
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
base: master
Are you sure you want to change the base?
docs(third-party): separate providers and template docs #1664
Conversation
83d09d7 to
fce66b7
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. 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
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
Can we call them differently? I don't think they are "templates", and templates already fill another roll. |
|
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. |
Line 10 in d037977
In this page, it is also called "rules" |
fce66b7 to
2310df6
Compare
|
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. 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. Maybe it would make more sense to have:
or all of them |
|
Sounds good. |
3262f88 to
e420d5b
Compare
0756a66 to
75e43ba
Compare
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. |
75e43ba to
e11ebbc
Compare

Documentation Changes
poetry doclocally to ensure the documentation pages renders correctly