Skip to content

docs: update the contributing guide and agent rules - #1208

Merged
vdusek merged 2 commits into
masterfrom
docs/polish-agent-rules
Nov 6, 2026
Merged

vdusek merged 2 commits into
masterfrom
docs/polish-agent-rules

Conversation

@vdusek

@vdusek vdusek commented Nov 6, 2026

Copy link
Copy Markdown
Contributor

Small cleanup of CONTRIBUTING.md and .rules.md:

  • Reword the YAML rule: leave values unquoted unless quotes are needed, then use double quotes. Crawlee and the SDK get the same rule.
  • Move the from __future__ import annotations bullet from "Comments and docstrings" to "Readability" and mention the __init__.py exception.
  • Under "Generated models", ask to point out a regeneration that adds a pattern, length limit, maxItems or const to a request model, since the client then rejects that input before sending the request.
  • Rename "Additional context" in .rules.md to "Related repositories" and name the repositories review-references.yaml covers.
  • State the full requirement for running the docs locally (Node.js 22.12 or newer and pnpm), and unwrap the two hard-wrapped paragraphs in "Linting the docs and website".

✍️ Drafted by Claude Code

@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 Nov 6, 2026
@vdusek vdusek self-assigned this Nov 6, 2026
@codecov

codecov Bot commented Nov 6, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.74%. Comparing base (b1dd6c2) to head (9b81aeb).
⚠️ Report is 3 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1208   +/-   ##
=======================================
  Coverage   95.74%   95.74%           
=======================================
  Files          63       63           
  Lines        6678     6678           
=======================================
  Hits         6394     6394           
  Misses        284      284           
Flag Coverage Δ
integration 91.10% <ø> (+0.22%) ⬆️
unit 90.70% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 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 changed the title docs: polish the contributing guide and agent rules docs: update the contributing guide and agent rules Nov 6, 2026
@vdusek
vdusek marked this pull request as ready for review November 6, 2026 09:43
@vdusek
vdusek requested a review from apify-factory November 6, 2026 09:43

@apify-factory apify-factory left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks good, nothing blocking.

🏭 Apify Factory auto approved ✅ — went through the gates like they were not there

Every gate passed, and neither the reviewer nor a juror found anything a human needs to look at.

Approval locked to 9b81aeb73 · workflow run

@vdusek
vdusek merged commit eb975b4 into master Nov 6, 2026
40 of 41 checks passed
@vdusek
vdusek deleted the docs/polish-agent-rules branch November 6, 2026 11:15
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.

2 participants