Skip to content

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

Merged
merged 1 commit into from
Jun 26, 2020

Conversation

Lee-W
Copy link
Member

@Lee-W Lee-W commented Jun 24, 2020

Types of changes

Please put an x in the box that applies

  • Documentation Update

Description

update title level for customization documentation

from
image

to
image

Checklist:

  • Add test cases to all the changes you introduce
  • Run ./script/lint and ./script/test locally to ensure this change passes linter check and test
  • Test the changes on the local machine manually
  • Update the documentation for the changes

Steps 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.

@Lee-W Lee-W requested a review from woile June 24, 2020 10:01
@Lee-W Lee-W force-pushed the unify-customization-doc-title-level branch from 8a04cbb to 14f5de8 Compare June 24, 2020 10:01
@codecov
Copy link

codecov bot commented Jun 24, 2020

Codecov Report

Merging #207 into master will not change coverage.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #207   +/-   ##
=======================================
  Coverage   95.64%   95.64%           
=======================================
  Files          34       34           
  Lines         942      942           
=======================================
  Hits          901      901           
  Misses         41       41           
Flag Coverage Δ
#unittests 95.64% <100.00%> (ø)
Impacted Files Coverage Δ
commitizen/__version__.py 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update cbb9ad7...14f5de8. Read the comment docs.

@woile
Copy link
Member

woile commented Jun 24, 2020

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 info be configured through file configuration?

The idea of the class approach is:

  1. Publish to your pypi
  2. Teams install
  3. If updated -> teams update the package

@Lee-W
Copy link
Member Author

Lee-W commented Jun 24, 2020

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 info be 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.

@woile
Copy link
Member

woile commented Jun 25, 2020

Agreed, this is fine as well 👍

@woile woile merged commit b2d4558 into master Jun 26, 2020
@woile woile deleted the unify-customization-doc-title-level branch June 26, 2020 13:00
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.

2 participants