Conversation
| ## XLS_TEMPLATE.md — Required Top-Level Sections | ||
|
|
||
| ``` | ||
| ## 1. Abstract ← required |
There was a problem hiding this comment.
I'm worried about this being too rigid about numbers
There was a problem hiding this comment.
Right, that it would complain if we introduced a section that is not in the list, and break the numbering?
There was a problem hiding this comment.
Pull request overview
Adds a GitHub Copilot instruction document under .github/ to capture XRPL-Standards repo structure and key validation/template rules for reviewing and authoring XLS Markdown specs.
Changes:
- Add
.github/copilot-instructions.mddocumenting repo layout, required XLS preamble fields, and template compliance expectations. - Summarize Amendment template section structure and placeholder rejection rules enforced by CI.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| For Amendment-category XLSes, `## 3. Specification` contains components as `### 3.N. ComponentType: \`Name\``subsections. Each component has numbered sub-subsections`#### 3.N.M.` and deeper. | ||
|
|
||
| ### Ledger Entry (`### 3.N. Ledger Entry: \`Name\``) |
There was a problem hiding this comment.
Markdown formatting around the Amendment template heading examples is broken: the inline-code span uses \-escaped backticks (which render literally inside code spans) and there are missing spaces ("``subsections" / "sub-subsections`####"). Consider rewriting these examples using either double-backtick code spans (so literal backticks render correctly) or a fenced code block, and fix the missing spaces for readability.
| For Amendment-category XLSes, `## 3. Specification` contains components as `### 3.N. ComponentType: \`Name\``subsections. Each component has numbered sub-subsections`#### 3.N.M.` and deeper. | |
| ### Ledger Entry (`### 3.N. Ledger Entry: \`Name\``) | |
| For Amendment-category XLSes, `## 3. Specification` contains components as headings like ``### 3.N. ComponentType: `Name` `` subsections. Each component has numbered sub-subsections like ``#### 3.N.M.`` and deeper. | |
| ### Ledger Entry (example heading: ``### 3.N. Ledger Entry: `Name` ``) |
| | Ledger Entry Fields | `Field Name \| Constant \| Required \| Internal Type \| Default Value \| Description` | | ||
| | Transaction Fields | `Field Name \| Required? \| JSON Type \| Internal Type \| Default Value \| Description` | | ||
| | Flags (both) | `Flag Name \| Flag Value \| Description` | | ||
| | RPC Request Fields | `Field Name \| Required? \| JSON Type \| Description` | | ||
| | RPC Response Fields | `Field Name \| Always Present? \| JSON Type \| Description` | | ||
| | Transaction Metadata | `Field Name \| Validated \| Always Present? \| Type \| Description` | |
There was a problem hiding this comment.
In the “Table Schemas” table, the column strings are wrapped in inline code and also escape pipes as \|. Inside an inline-code span the backslash is rendered literally, so this will display \| instead of |. To show the exact headings, prefer a fenced code block for each schema (or remove the outer code span and keep the \| escaping so it renders as literal | inside the table cell).
| | Ledger Entry Fields | `Field Name \| Constant \| Required \| Internal Type \| Default Value \| Description` | | |
| | Transaction Fields | `Field Name \| Required? \| JSON Type \| Internal Type \| Default Value \| Description` | | |
| | Flags (both) | `Flag Name \| Flag Value \| Description` | | |
| | RPC Request Fields | `Field Name \| Required? \| JSON Type \| Description` | | |
| | RPC Response Fields | `Field Name \| Always Present? \| JSON Type \| Description` | | |
| | Transaction Metadata | `Field Name \| Validated \| Always Present? \| Type \| Description` | | |
| | Ledger Entry Fields | Field Name \| Constant \| Required \| Internal Type \| Default Value \| Description | | |
| | Transaction Fields | Field Name \| Required? \| JSON Type \| Internal Type \| Default Value \| Description | | |
| | Flags (both) | Flag Name \| Flag Value \| Description | | |
| | RPC Request Fields | Field Name \| Required? \| JSON Type \| Description | | |
| | RPC Response Fields | Field Name \| Always Present? \| JSON Type \| Description | | |
| | Transaction Metadata | Field Name \| Validated \| Always Present? \| Type \| Description | |
Updated instructions for Copilot Cloud Agent in XRPL-Standards repository, including repository purpose, layout, and key rules. Co-authored-by: mvadari <mvadari@gmail.com>
| 1. Start in GitHub Discussions (Idea or Proposal stage) — do **not** open a PR until there is community feedback. | ||
| 2. Create a directory named `XLS-draft-<short-title>/` (agents/authors must NOT self-assign numbers for XLS numbers > 95). | ||
| 3. Copy `templates/XLS_TEMPLATE.md` to `XLS-draft-<short-title>/README.md` and fill it in. | ||
| 4. Open a PR. CI will assign the official XLS number automatically after a maintainer with write access approves; the `assign-xls-number.yml` workflow renames the directory and updates the preamble. |
There was a problem hiding this comment.
| 4. Open a PR. CI will assign the official XLS number automatically after a maintainer with write access approves; the `assign-xls-number.yml` workflow renames the directory and updates the preamble. | |
| 4. Open a PR. CI will assign the official XLS number automatically after a maintainer with write access approves; the `assign-xls-number.yml` workflow renames the directory and updates the preamble. Authors should not assign their own XLS number. |
High Level Overview of Change
Context of Change
Type of Change
Co-authored-by: mvadari mvadari@gmail.com