Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Admin] Updates for the new ARC process. #87

Merged
merged 9 commits into from
Jan 27, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/0_proposal.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: 🚀 Proposal
about: Propose a new ARC
title: "[Proposal] ARC-XXXX: Insert Title Here"
labels: 'status-draft'
---
**Discussion Thread:** _TODO. Insert a link to the corresponding discussion thread here._


## 🚀 Proposal
<!-- A brief description of the proposal -->

## Voting History
- None yet.

## Notes to Reviewers
<!-- Any notes that you would like to share with the reviewers -->



10 changes: 10 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/1_update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
name: 🔨Update
about: Update an existing ARC.
title: "[Update] ARC-XXXX: Insert Title Here"
labels: 'update'
---

## 🔨 Update
<!-- A brief description of the update and why it is necessary -->

5 changes: 5 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: ❓ Q&A
url: https://discord.gg/aleo
about: For questions or technical troubleshooting, please ask them in the Aleo Discord.
File renamed without changes.
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
9 changes: 3 additions & 6 deletions arc-0001/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,13 @@ graph LR
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 @@ -49,11 +48,9 @@ graph LR

`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`.
`Withdrawn` refers to a proposal that was previously marked as `Draft`, or `Active`.

`Accepted` refers to a proposal that was `Active` with a reference implementation, and has been approved by reviewer(s).

`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
Loading