Skip to content

Commit

Permalink
fix type category table on hip 1
Browse files Browse the repository at this point in the history
  • Loading branch information
mgarbs committed Dec 2, 2024
1 parent eee0bbe commit fdc471c
Showing 1 changed file with 19 additions and 17 deletions.
36 changes: 19 additions & 17 deletions HIP/hip-1.md
Original file line number Diff line number Diff line change
Expand Up @@ -225,23 +225,25 @@ HIPs should be written in markdown format. There is a template to follow.

Each HIP must begin with a header preamble in a table format. The headers must appear in the following order. Headers marked with "*" are optional and are described below. All other headers are required.

- hip: HIP number (this is determined by the PR number and set by the editor)
- title: HIP title
- author: a list of the author's or authors' name(s) and/or username(s), or name(s) and email(s)
- working-group\*: a list of the technical and business stakeholders' name(s) and/or username(s), or name(s) and email(s)
- requested-by: the name(s) and/or username(s), or name(s) and email(s) of the individual(s) or project(s) requesting the HIP
- type: Standards Track | Informational | Process
- category\*: Core | Service | API | Mirror | Application
- needs-tsc-approval: Yes | No
- status: Draft | Withdrawn | Review | Stagnant | Deferred | Last Call | Accepted | Rejected | Final | Active | Replaced
- created: date created on
- last-call-date-time: the anticipated date and time when this HIP will change status to `Last Call`, filled out by the editor
- discussions-to: a URL pointing to the official discussion thread
- updated\*: comma-separated list of dates
- requires\*: HIP number(s)
- replaces\*: HIP number(s)
- superseded-by\*: HIP number(s)
- release\*: release version of implementation
| Field | Description |
|-------|-------------|
| hip | HIP number (determined by PR number and set by editor) |
| title | HIP title |
| author | List of authors' names/usernames or names/emails |
| working-group* | List of stakeholders' names/usernames or names/emails |
| requested-by | Names/usernames or names/emails of requesters |
| type | Standards Track, Informational, or Process |
| category* | Core, Service, API, Mirror, or Application |
| needs-tsc-approval | Yes or No |
| status | Current status |
| created | Creation date |
| last-call-date-time | Expected Last Call status date/time |
| discussions-to | URL of discussion thread |
| updated* | Comma-separated dates list |
| requires* | Required HIP numbers |
| replaces* | Replaced HIP numbers |
| superseded-by* | Superseding HIP numbers |
| release* | Implementation version |

Headers that permit lists must separate elements with commas.

Expand Down

0 comments on commit fdc471c

Please sign in to comment.