Skip to content

docs: consolidate contributing guide and agent rules - #1180

Merged
vdusek merged 7 commits into
masterfrom
docs/update-agent-rules
Oct 15, 2026
Merged

vdusek merged 7 commits into
masterfrom
docs/update-agent-rules

Conversation

@vdusek

@vdusek vdusek commented Oct 14, 2026 •

Copy link
Copy Markdown
Contributor

Makes CONTRIBUTING.md the single source of development conventions. .rules.md (the target of CLAUDE.md, AGENTS.md and GEMINI.md) links and imports it and keeps only the Pydantic and architecture notes.

  • Removes duplication between .rules.md, CONTRIBUTING.md, README.md and pyproject.toml. Poe tasks have help texts, so uv run poe replaces the task table.
  • Adds code style, test and commit conventions agreed in past reviews.
  • Fixes drift: the integration vs. E2E test description and the architecture notes.
  • The test READMEs cover common setup failures and platform timing quirks.

✍️ 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 Oct 14, 2026
@vdusek vdusek self-assigned this Oct 14, 2026
@codecov

codecov Bot commented Oct 14, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.05%. Comparing base (3ed1a48) to head (389d37f).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1180   +/-   ##
=======================================
  Coverage   93.05%   93.05%           
=======================================
  Files          54       54           
  Lines        3671     3671           
=======================================
  Hits         3416     3416           
  Misses        255      255           
Flag Coverage Δ
e2e 31.73% <ø> (ø)
integration 51.70% <ø> (ø)
unit 89.78% <ø> (ø)

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: update .rules.md and add coding and test conventions docs: deduplicate contributing guide and agent rules Oct 14, 2026
@vdusek vdusek changed the title docs: deduplicate contributing guide and agent rules docs: consolidate contributing guide and agent rules Oct 14, 2026
@vdusek
vdusek marked this pull request as ready for review October 14, 2026 11:29
@vdusek
vdusek requested review from Mantisus and Pijukatel October 14, 2026 11:30
@apify-service-account apify-service-account added the tested Temporary label used only programatically for some analytics. label Oct 14, 2026

@apify-approval-mirror apify-approval-mirror Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Mirroring approval from @Mantisus.

@vdusek
vdusek merged commit 5f53f48 into master Oct 15, 2026
31 checks passed
@vdusek
vdusek deleted the docs/update-agent-rules branch October 15, 2026 06:32
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. tested Temporary label used only programatically for some analytics.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants