Skip to content

Bring CONTRIBUTING and the CLI reference in line with main - #149

Merged
Deicyde merged 2 commits into
mainfrom
docs/contrib-cli-20261005
Oct 6, 2026
Merged

Deicyde merged 2 commits into
mainfrom
docs/contrib-cli-20261005

Conversation

@Deicyde

@Deicyde Deicyde commented Oct 6, 2026

Copy link
Copy Markdown
Contributor

Summary

  • CONTRIBUTING.md was the unedited template: a "..." placeholder for the development process, 2-space and 80-column rules, and a blank project name. It now gives the make targets CI runs, what the Lean and Windows CI jobs cover and which local tests skip without Lean, the ruff setup (default rules, which leave the 120-character limit in pyproject.toml unenforced), and the project name.
  • CLI reference: two passages named the deprecated worker stack after a GitHub account. The doctor section now says "a future worker fleet". The claim section drops a sentence saying those workers must remove their continue-uncoordinated failure behavior before using the claim API; the execution branch's scheduler already uses ClaimBoard and fails closed. The commands section says the PATH form assumes the Python package is installed, and that a consumer project lacks the package, not the plugin.

Docs only: no code, manifest, test, or README changes. The README rewrite landed in #133.

Overlap

git merge-tree against every open PR head finds conflicts beyond the ones each PR already has with main only here:

Validation

At e565b24 (two commits on main e12382d): uv run pytest -q tests/test_skill_examples.py tests/test_markdown.py, 71 passed, and ruff check is clean. tests/test_skill_examples.py is the only test that reads a changed file (the CLI reference); no test reads CONTRIBUTING.md.

CONTRIBUTING.md was still the unedited template: a "..." placeholder
for the development process, 2-space and 80-column style rules, and a
blank project name in the license section. It now lists the make
targets CI runs, the style rules the repository uses (ruff check with
default rules, the 120-character line length from pyproject.toml, no
formatter), and the project name.

Two passages in the CLI reference named the deprecated worker stack
after a GitHub account. The doctor section now says "a future worker
fleet". The claim section's sentence about those workers is removed:
it said their continue-uncoordinated failure behavior must go before
they use the claim API, but the execution branch's scheduler already
uses ClaimBoard and fails closed. The commands section now says the
PATH form assumes the Python package is installed, which until now
only the README said, and that a consumer project lacks the package,
not the plugin whose root it then resolves.
The Windows job runs all of tests/test_project_inspect.py, not only part
of tests/test_skeleton.py, and the real-Lean job also runs one
tests/test_project_inspect.py test. Only the tests/test_skeleton.py
real-Lean tests skip when the pinned toolchain is missing; the real-Lake
tests in tests/test_lake_artifact_audit.py and
tests/test_project_inspect.py skip only without lake, and elan downloads
the toolchain for them. Ruff's default rules leave out E501, so the
120-character limit in pyproject.toml is not enforced and some lines
exceed it.
@meta-cla meta-cla Bot added the CLA Signed This label is managed by the Meta Open Source bot. label Oct 6, 2026
@Deicyde
Deicyde marked this pull request as draft October 6, 2026 00:13
@Deicyde
Deicyde marked this pull request as ready for review October 6, 2026 00:26
@Deicyde
Deicyde merged commit 9480fd3 into main Oct 6, 2026
9 checks passed
@Deicyde
Deicyde deleted the docs/contrib-cli-20261005 branch October 6, 2026 00:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed This label is managed by the Meta Open Source bot.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant