Repository navigation
docs: split shared dev guidelines from personal claude instructions - #9640
Merged
Merged
Conversation
Check in CLAUDE.md, move code and language rules to dev-guidelines/, add the open-pr skill, and make the PR template follow the PR report format.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
CLAUDE.mdthat each of us kept for ourselves and that git ignored. Now a shared, checked-inCLAUDE.mdgives the commands, the two modes of running PySyft (DO and DS, or an enclave), and the workspace packages, and it imports the guidelines. Personal instructions, such as credentials, go in aCLAUDE.local.mdthat git ignores.CLAUDE.md, thesyft-pr-reviewskill andCONTRIBUTING.md, and they disagreed in places. Now the code rules live indev-guidelines/guidelines.md, and the rules for writing about code live indev-guidelines/language.md.CLAUDE.md,syft-pr-review,open-prandCONTRIBUTING.mdall point there.dev-guidelines/guidelines.md, and a security note, plus testing and the Asana task.CONTRIBUTING.mddescribes this format and says every PR must follow it.CLAUDE.md. Now it readsdev-guidelines/architecture/<topic>.md, andCLAUDE.mdsays when to read each file.sync-flow.mdis new: it describes one sync pass as the code insyft/sync/runs it.syft-pr-reviewwrites a review, it now rates the PR against the guidelines in three short lines under its summary, and it takes its code standards fromdev-guidelines/guidelines.mdinstead of its own list.open-prskill opens a PR in this format: it runs pre-commit, writes a conventional-commit title, and fills in the template.Guidelines
High level
Mid level
Low level
Security
No change.
Testing
pre-commit run --all-filespasses.syft-pr-reviewandreview-uion fix: close two allow-list bypasses in syft-restrict. #9636 with the changed review skill, and checked the result in the review UI.Asana task