Skip to content

Commit da494f2

Browse files
update instructions
1 parent 25e9b1a commit da494f2

4 files changed

Lines changed: 27 additions & 245 deletions

File tree

AGENTS.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Instructions for clankers
2+
3+
When reading source files, ingest them in their entirety instead of relying on search/grep tools.
4+
5+
Read `README.md` and `CONTRIBUTING.rst` first.
6+
7+
When implementing functional code changes, be sure to read the DSDL specification in <https://github.com/OpenCyphal/specification>.
8+
9+
## Project Structure & Module Organization
10+
11+
- Core library code lives in `pydsdl/`.
12+
- Key internal subpackages are `pydsdl/_expression/`, `pydsdl/_serializable/`.
13+
- Vendored dependencies are under `pydsdl/third_party/` (treat as external code; modify only when intentionally syncing).
14+
- Tests are mostly co-located with implementation. Larger suites are in `pydsdl/_test*.py`, they are never imported.
15+
- Documentation sources are in `docs/`.
16+
- Test and release automation is in `noxfile.py` and `.github/`.
17+
18+
## Commit & Pull Request Guidelines
19+
20+
Provide detailed commit messages explaining the rationale behind the changes. Aim for a brief title with a following expanded description explaining what has been done and why was it necessary.

CLAUDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
AGENTS.md

CONTRIBUTING.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,12 @@
33
Development guide
44
=================
55

6-
This document is intended for library developers only.
6+
This document is intended for library developers and AI agents only.
77
If you just want to use the library, you don't need to read it.
88

9-
Development automation is managed by Nox; please see ``noxfile.py``.
9+
Development automation is managed by Nox; please read ``noxfile.py``.
10+
11+
The coding style is PEP8 with max line length 120 characters.
1012

1113

1214
Writing tests
@@ -26,18 +28,16 @@ outside of test-enabled environments.
2628
import pytest # OK to import inside test functions only (rarely useful)
2729
assert get_the_answer() == 42
2830
31+
For targeted test runs: ``pytest pydsdl -k _unittest_whatever -v``.
32+
2933

3034
Supporting newer versions of Python
3135
+++++++++++++++++++++++++++++++++++
3236

33-
Normally, this should be done a few months after a new version of CPython is released:
34-
3537
1. Update the CI/CD pipelines to enable the new Python version.
3638
2. Update the CD configuration to make sure that the library is released using the newest version of Python.
3739
3. Bump the version number using the ``.dev`` suffix to indicate that it is not release-ready until tested.
3840

39-
When the CI/CD pipelines pass, you are all set.
40-
4141

4242
Releasing
4343
+++++++++

SERDES_IMPLEMENTATION_PLAN.md

Lines changed: 0 additions & 239 deletions
This file was deleted.

0 commit comments

Comments
 (0)