Skip to content

Commit

Permalink
Update
Browse files Browse the repository at this point in the history
  • Loading branch information
d0cd committed Jan 22, 2025
1 parent b330910 commit c0e390e
Show file tree
Hide file tree
Showing 13 changed files with 1,452 additions and 120 deletions.
26 changes: 23 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,29 @@ Aleo Request for Comments (ARCs) are protocol-level, network-level, and applicat
## ✍️ Getting Started

To create a new ARC proposal:
1. Copy template [ARC-0000](./arc-0000) into a new folder with the latest ARC number (ARC-XXXX)
2. Open a [Github Discussion](https://github.com/AleoHQ/ARCs/discussions/categories/arcs) for your ARC number
3. File a [Pull Request](https://github.com/AleoHQ/ARCs/pulls) to add your new ARC proposal
1. Open a [Github Discussion](https://github.com/AleoHQ/ARCs/discussions/categories/arcs) with your proposal using template [ARC-0000](./arc-0000) and an available ARC number.
2. File a [Pull Request](https://github.com/AleoHQ/ARCs/pulls) with your proposal in a new subdirectory.

### Progressing an ARC

An ARC will start as a "Draft" and progress through the following stages:

Once a proposal is up:
1. The community will discuss and review the proposal. A maintainer will monitor the ARC and change its status to "Active" once it is ready.
a. ARCs will be prioritized by number of votes and whether a prototype exists.
b. ARCs will be discussed during certain community calls. Proposers will have the opportunity to join and participate in the discussion.
c. Up to this point, the ARC can be withdrawn by the proposer or withdrawn by the maintainers if there is no activity for a long time.
2. A governor or a team member of the Aleo Network Foundation (ANF) will create a formal proposal on Aleo governance (https://vote.aleo.org/) and initiate the voting process.
3. The community will vote on the proposal for approval.
4. If the proposal is accepted, its status will be updated to "Accepted" and the associated pull request will be merged into the ARCs repo. If the proposal is rejected, the status will be reverted to "Draft".
5. The relevant parties should complete the implementation. Updates can be made to the ARC as needed through new PRs, which do not need votes.
6. Once the implementation is finalized, the status will change from "Accepted" to "Final" or "Living", depending on the nature of the proposal. The associated discussion will be closed.

A proposal can be "Deprecated" if it is replaced by a new proposal.

### Statuses

See [ARC-0001](./arc-0001) for a detailed explanation of the statuses.

## 📜 License

Expand Down
4 changes: 2 additions & 2 deletions arc-0000/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
arc: 0000 # Add the next sequence number
arc: 0 # Add an unused ARC number. **DO NOT ADD LEADING ZEROS.**
title: # Title
authors: # Add all Github usernames, emails, and/or full names
discussion: # Create a 'Github Discussion' titled 'ARC-XXXX: {TITLE}`
topic: # Choose: Protocol, Network, or Application
topic: # Choose: Protocol, Network, Application, or Meta
status: Draft
created: # Date
---
Expand Down
17 changes: 11 additions & 6 deletions arc-0001/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,21 +22,25 @@ ARC standards proposals should be labeled with one of the following categories:

### Process

<!-- generated by mermaid compile action - START -->
![~mermaid diagram 1~](/output/arc-0001_README-md-1.png)
<details>
<summary>Mermaid markup</summary>

```mermaid
graph LR
subgraph authors
draft([Draft]) --> active([Active])
end
draft([Draft]) -.-> withdrawn([Withdrawn])
active([Active]) -.-> withdrawn([Withdrawn])
subgraph standards
active([Active]) --> decision{Decision}
decision{Decision} --> accepted([Accepted])
end
decision{Decision} -.-> rejected([Rejected])
decision{Decision} -.-> rejected([Draft])
subgraph standards
accepted([Accepted]) --> final([Final])
Expand All @@ -45,15 +49,16 @@ graph LR
end
```

</details>
<!-- generated by mermaid compile action - END -->

`Draft` refers to a proposal that is currently undergoing development and is not ready for review.

`Active` refers to a proposal with a reference implementation that is ready for review.

`Withdrawn` refers to a proposal that was previously marked as `Idea`, `Draft`, or `Active`.

`Accepted` refers to a proposal that was `Active` with a reference implementation, and has been approved by reviewer(s).
`Withdrawn` refers to a proposal that was previously marked as `Draft`, or `Active`.

`Rejected` refers to a proposal that was `Active` with a reference implementation, and has been denied by reviewer(s).
`Accepted` refers to a proposal that has been approved by the community and is ready for implementation.

`Final` refers to a proposal that was `Accepted`, and the reference implementation has been incorporated into Aleo.

Expand Down
4 changes: 2 additions & 2 deletions arc-0002/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
arc: 2
arc: 0002
title: Aleo Virtual Machine (AVM)
authors: howardwu, acoglio, collinc97, d0cd
discussion: https://github.com/AleoHQ/ARCs/discussions/5
topic: Protocol
status: Draft
status: Living
created: 2020-02-07
---

Expand Down
105 changes: 0 additions & 105 deletions arc-0004/README.md

This file was deleted.

Loading

0 comments on commit c0e390e

Please sign in to comment.