Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

docs(config): split the configuration documentation into pages#1657

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged

Conversation

@bearomorphism
Copy link
Collaborator

@bearomorphismbearomorphism commentedNov 19, 2025•
edited
Loading

Why

docs/config.md basically mixed the usage of options that is only used by different cz commands together. It would be better if those options are categorized.

Also, duplication of option usage documentation occurs. It should be fixed.

This PR categorized and centralizes those configuration file options, and remove the duplication of option usages.

The configuration file doc and version provider doc have their own pages now.

Checklist

Documentation Changes

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

@codecov
Copy link

codecovbot commentedNov 19, 2025•
edited
Loading

Codecov Report

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

Additional details and impacted files
@@            Coverage Diff             @@##           master    #1657      +/-   ##==========================================+ Coverage   97.33%   98.68%   +1.34%==========================================  Files          42       60      +18       Lines        2104     2656     +552     ==========================================+ Hits         2048     2621     +573+ Misses         56       35      -21
FlagCoverage Δ
unittests98.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.

@bearomorphismbearomorphism marked this pull request as ready for reviewNovember 19, 2025 09:17
@bearomorphismbearomorphism marked this pull request as draftNovember 19, 2025 13:50
@bearomorphism
Copy link
CollaboratorAuthor

bearomorphism commentedNov 19, 2025•
edited
Loading

I need time to review and improve it.

@bearomorphism
Copy link
CollaboratorAuthor

Now it is ready for review. I will probably use AI to improve the wording in the documentation in some future PRs.

Let's improve the structure first.

Lee-W reacted with thumbs up emoji

@bearomorphismbearomorphism mentioned this pull requestDec 1, 2025
4 tasks
@bearomorphism
Copy link
CollaboratorAuthor

Checked#1236 and moved the new content topython_class.md.

Copy link
Member

@Lee-WLee-W left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

A few nitpicks but nothing is actally blocking

Co-authored-by: Wei Lee <weilee.rx@gmail.com>
@bearomorphismbearomorphism merged commit583acf4 intocommitizen-tools:masterDec 10, 2025
18 checks passed
@bearomorphismbearomorphism deleted the doc-config-2 branchDecember 10, 2025 13:34
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment

Reviewers

@Lee-WLee-WLee-W approved these changes

@woilewoileAwaiting requested review from woilewoile is a code owner

@noirbizarrenoirbizarreAwaiting requested review from noirbizarrenoirbizarre is a code owner

Assignees

No one assigned

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@bearomorphism@Lee-W
[8]ページ先頭
©2009-2025 Movatter.jp