Skip to content

Developer documentation - #340

Merged
gpeairs merged 17 commits into
mainfrom
gp/devdocs
Oct 29, 2026
Merged

gpeairs merged 17 commits into
mainfrom
gp/devdocs

Conversation

@gpeairs

@gpeairs gpeairs commented Sep 30, 2026 •

Copy link
Copy Markdown
Member

Closes #1.

Adds notes for contributors and maintainers. Also adds AGENTS.md pointing to these docs, and a script for running filtered testitems correctly, in the test environment, from the command line.

Preview build here.

@codecov

codecov Bot commented Sep 30, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@gpeairs gpeairs left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Some notes to self for the next round of revisions


On Julia versions before 1.13, `Pkg.test()` runs with `--check-bounds=yes`, so it can't reuse
the precompile cache from development and recompiles DeviceLayout and its dependencies. Prefer
the TestEnv routes for iteration on those versions.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

3 and 4 are nice because they can use a persistent Julia process

Comment thread docs/src/developers/architecture.md Resolved
Comment thread docs/src/developers/principles.md Resolved
Comment thread docs/src/developers/contributing.md Resolved
Comment thread docs/src/developers/contributing.md Resolved
Comment thread docs/src/developers/maintenance.md Resolved
Comment thread docs/src/developers/maintenance.md Resolved
Comment thread docs/src/developers/maintenance.md Resolved
Comment thread scripts/test.jl Resolved
@gpeairs gpeairs mentioned this pull request Oct 7, 2026
1 task
Comment thread AGENTS.md Resolved
@gpeairs
gpeairs requested a review from laylagi October 26, 2026 14:58

@laylagi laylagi 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.

Thanks for this PR, it's very helpful! I have a few small comments.

Comment thread docs/src/developers/contributing.md Resolved
Comment thread CONTRIBUTING.md Resolved
Comment thread scripts/test.jl Resolved
@laylagi
laylagi self-requested a review October 28, 2026 16:17

@laylagi laylagi 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.

Thanks, LGTM!

@parrangoiz

Copy link
Copy Markdown
Contributor

Same, looks much better now.

@gpeairs
gpeairs merged commit a62e760 into main Oct 29, 2026
11 checks passed
@gpeairs
gpeairs deleted the gp/devdocs branch October 29, 2026 12:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Developer docs

3 participants