-
-
Notifications
You must be signed in to change notification settings - Fork 301
docs(customization): update title level #207
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
Conversation
8a04cbb to
14f5de8
Compare
Codecov Report
@@ Coverage Diff @@ ## master #207 +/- ## ======================================= Coverage 95.64% 95.64% ======================================= Files 34 34 Lines 942 942 ======================================= Hits 901 901 Misses 41 41
Continue to review full report at Codecov.
|
My concern with making "Customize in configuration file" the first approach we recommend is:
- How can teams reuse the designed in file configuration?
- Can
cz schema,cz example,cz infobe configured through file configuration?
The idea of the class approach is:
- Publish to your pypi
- Teams install
- If updated -> teams update the package
How can teams reuse the designed in file configuration?
It would be a bit hard for team to reuse it. The reason why I move it to the front is because it's the easier way to config.
Can
cz schema,cz example,cz infobe configured through file configuration?
Yes.
e.g.,
[tool.commitizen] ... schema = ...
The idea of the class approach is:
1. Publish to your pypi 2. Teams install 3. If updated -> teams update the package
I consider it a more advanced usage. But it also occurs to me that we can write it down more explicitly how we want user to use it.
Agreed, this is fine as well 👍
Types of changes
Please put an
xin the box that appliesDescription
update title level for customization documentation
from
image
to
image
Checklist:
./script/lintand./script/testlocally to ensure this change passes linter check and testSteps to Test This Pull Request
None
Expected behavior
None
Related Issue
If applicable, reference to the issue related to this pull request.
Additional context
Add any other context or screenshots about the pull request here.