Skip to content

docs: expand .rules.md with model generation and commit type guidance#732

Merged
vdusek merged 1 commit intomasterfrom
docs/expand-rules-md-with-models-and-commits
Apr 16, 2026
Merged

docs: expand .rules.md with model generation and commit type guidance#732
vdusek merged 1 commit intomasterfrom
docs/expand-rules-md-with-models-and-commits

Conversation

@vdusek
Copy link
Copy Markdown
Contributor

@vdusek vdusek commented Apr 16, 2026

Expands .rules.md with two improvements:

  • Model generation: details the full regeneration flow — datamodel-code-generator config, the postprocess script, local poe commands, and how CI auto-triggers from apify/apify-docs PRs
  • Commit types: clarifies which Conventional Commit types (feat/fix/perf/refactor/style) trigger a release and must be used for source code only, and maps the remaining types (test:, docs:, ci:, chore:, build:) to their correct scope

Add detailed model regeneration steps (local and CI via apify-docs),
and clarify which Conventional Commit types trigger releases vs. not.
@vdusek vdusek added adhoc Ad-hoc unplanned task added during the sprint. t-tooling Issues with this label are in the ownership of the tooling team. labels Apr 16, 2026
@vdusek vdusek self-assigned this Apr 16, 2026
@github-actions github-actions bot added this to the 138th sprint - Tooling team milestone Apr 16, 2026
@codecov
Copy link
Copy Markdown

codecov bot commented Apr 16, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.34%. Comparing base (6eb9aee) to head (df6c692).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #732      +/-   ##
==========================================
+ Coverage   95.30%   95.34%   +0.03%     
==========================================
  Files          45       45              
  Lines        5115     5115              
==========================================
+ Hits         4875     4877       +2     
+ Misses        240      238       -2     
Flag Coverage Δ
integration 95.34% <ø> (+0.03%) ⬆️

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.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@vdusek vdusek requested a review from Pijukatel April 16, 2026 11:57
@vdusek vdusek merged commit 9cb5260 into master Apr 16, 2026
26 checks passed
@vdusek vdusek deleted the docs/expand-rules-md-with-models-and-commits branch April 16, 2026 12:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

adhoc Ad-hoc unplanned task added during the sprint. t-tooling Issues with this label are in the ownership of the tooling team.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants