Add AGENTS.md for AI coding agent guidance#357
Open
ye0man wants to merge 1 commit intocashubtc:mainfrom
Open
Conversation
joemphilips
reviewed
Apr 3, 2026
| - **Horizontal rule**: `---` separating the header block from the body. | ||
| - **RFC 2119 language**: Use `MUST`, `MUST NOT`, `SHOULD`, `SHOULD NOT`, `MAY`, and `CAN` (capitalized) per RFC 2119 when specifying protocol requirements. | ||
| - **API endpoints**: All REST endpoints use the `/v1/` prefix. Show the HTTP method and URL in a ` ```http ` code block, followed by request/response bodies in ` ```json ` blocks. | ||
| - **Type annotations in JSON**: Use angle-bracket placeholders for types: `<str>`, `<int>`, `<bool>`, `<Array[Type]>`, `<optional>`. |
There was a problem hiding this comment.
There are also other types used in the existing documents. Here's the list
- Primitives:
<str>,<int>,<bool>,<hex_str>,<bigint> - Nullable:
<type|null>(e.g.<str|null>,<int|null>,<Object|null>) - Enums:
<str_enum[NAME]>(e.g.<str_enum[STATE]>,<str_enum[UNIT]>) - Arrays:
<Array[Type]>(e.g.<Array[Proof]>,<Array[BlindSignature]>) - Named objects:
<Proof>,<BlindedMessage>,<BlindSignature>, etc. - Domain-specific:
<keyset_id_hex_str>,<public_key_str>,<amount_int> - Optional marker:
<optional>(marks a field as optional)
I think just saying "Use angle brackets to annotate type in the JSON document instead of an actual value" is fine. You don't need to specify possible types here. Since it seems like types are loosely deifned/used in the existing documents.
| - **Filename**: Zero-padded two-digit number matching the NUT number (e.g. `30.md` for NUT-30). | ||
| - **Title**: `# NUT-NN: Title` as the first line. | ||
| - **Status badge**: `` `mandatory` `` or `` `optional` `` on its own line after the title. | ||
| - **Dependencies** (if any): `` `depends on: NUT-NN` `` and/or `` `uses: NUT-NN` `` on separate lines. |
There was a problem hiding this comment.
There is also used in: NUT-NN notation which is widely used (04, 05, 07, 09, 10, 21). Don't we need this?
joemphilips
added a commit
to joemphilips/nuts
that referenced
this pull request
Apr 3, 2026
- Trim CTF.md from 706 to 533 lines, CTF-split-merge.md from 525 to 218 lines - Move supplementary material (Q&A, rationale, witness comparison, complete example) to suppl/ - Align with PR cashubtc#357 conventions: http code blocks, curl examples, Alice/Bob framing - Keep normative content intact; no behavioral changes
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
2 participants
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.
No description provided.