Skip to content

Commit 2ae10f5

Browse files
committed
docs: remove private repo names from public AGENTS.md, add PR rules and confidentiality section
- Remove all mentions of scimm and maestro (private repos) from public-facing content - Add confidentiality section warning agents not to mention private repos - Add PR title emoji rules from .github/pull_request_template.md - Add PR checklist reference
1 parent a51ac95 commit 2ae10f5

2 files changed

Lines changed: 30 additions & 17 deletions

File tree

AGENTS.md

Lines changed: 29 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Published on PyPI as `pyplaid`, it provides a structured format for representing
77
simulation data (meshes, fields, boundary conditions) and abstracts storage backends
88
(zarr, HuggingFace datasets, CGNS).
99

10-
Every other library in the ecosystem depends on plaid.
10+
Other libraries in the ecosystem depend on plaid.
1111

1212
## Expected agent behavior
1313

@@ -26,9 +26,16 @@ and open-source library design. You prioritize backward compatibility and clean
2626

2727
- Do not change public API signatures without explicit approval
2828
- Prefer adding new optional parameters with sensible defaults
29-
- Check if the change impacts `scimm` or `maestro` (downstream consumers)
29+
- Check if the change impacts downstream consumers of plaid
3030
- Run the full test suite before proposing changes
3131

32+
### Confidentiality
33+
34+
plaid is a **public** repository. Some downstream libraries in the PLAID ecosystem are private.
35+
Never mention private repository names, internal project names, or confidential details
36+
in any public-facing content (code comments, docstrings, commit messages, PR descriptions,
37+
issues, or documentation).
38+
3239
## Tech stack
3340

3441
- **Language**: Python 3.11--3.13
@@ -82,20 +89,6 @@ Storage uses a **Registry pattern** (`storage/registry.py`) to dispatch read/wri
8289
operations to the correct backend (zarr, hf_datasets, cgns). Each backend implements
8390
a `reader.py` and `writer.py` following a common interface defined in `storage/common/`.
8491

85-
### Dependency graph (ecosystem)
86-
87-
```
88-
plaid (pyplaid) scimm
89-
^ ^
90-
| pyplaid>=0.1.13 | scimm>=0.2.0
91-
| |
92-
+----------+-------------+
93-
|
94-
maestro (glue layer)
95-
```
96-
97-
plaid has **no dependency** on scimm or maestro. Changes here propagate downstream.
98-
9992
## Code conventions
10093

10194
### Formatting and linting
@@ -145,6 +138,26 @@ Guidelines:
145138
- Mock external dependencies (file I/O, network) to keep tests fast
146139
- Do not test trivial code or third-party libraries
147140

141+
## Pull request rules
142+
143+
PR titles **must start with one of the following emojis** to indicate the type of change:
144+
145+
| Emoji | Type |
146+
|-------|------|
147+
| 🐛 | Bug fix |
148+
| 📄 | Documentation |
149+
| 🎉 | New feature or initial commit |
150+
| 🚀 | Performance or deployment |
151+
| ♻️ | Refactor or cleanup |
152+
| 📦 | Packaging or dependency management |
153+
154+
PR checklist (from `.github/pull_request_template.md`):
155+
- Typing enforced
156+
- Documentation updated
157+
- Changelog updated
158+
- Tests and example updates
159+
- Coverage should be 100%
160+
148161
## Commands
149162

150163
```bash

src/plaid/containers/AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ This module defines the core data containers of the PLAID data model.
2121

2222
## Downstream impact
2323

24-
These classes are the public API surface consumed by `maestro` and end users. Any signature change is a **breaking change** that requires a major version bump.
24+
These classes are the public API surface consumed by downstream libraries and end users. Any signature change is a **breaking change** that requires a major version bump.
2525

2626
## Testing
2727

0 commit comments

Comments
 (0)