Skip to content

Commit

Permalink
Update CHIP-1 (#99)
Browse files Browse the repository at this point in the history 
* Add Discord links to CHIP-1

* Add link to video tutorial

* Link to video tutorial instead of embedding
  • Loading branch information
@danieljperry
danieljperry authored Mar 1, 2024
1 parent 8d4ef63 commit b096b57
Showing 1 changed file with 21 additions and 16 deletions.
37 changes: 21 additions & 16 deletions CHIPs/chip-0001.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,17 @@ CHIP Number | 0001
Title | CHia Improvement Proposal (CHIP) process
Description | A living document to outline the CHIP process, from Idea to Final.
Author | [Daniel Perry](https://github.com/danieljperry)
Comments-URI | https://github.com/Chia-Network/chips/wiki/Comments:CHIP-0001
Status | Living
Category | Process
Sub-Category | Procedural
Created | 2021-11-24
Dependencies | None
Updated | 2024-02-29

# CHia Improvement Proposals (CHIPs)

Contents:

* [Video Tutorial](#video-tutorial)
* [What is a CHIP?](#what-is-a-chip)
* [CHIP categories and sub-categories](#chip-categories-and-sub-categories)
* [Standards Track](#standards-track)
Expand Down Expand Up @@ -46,6 +46,10 @@ Contents:

---

## Video Tutorial

If you are a visual learner, we have created a [video tutorial](https://youtu.be/7uY_NT75pu8) for how to create a CHIP.

## What is a CHIP?
A CHIP is a formal design document. It uses a standard format, which will be laid out in this document. CHIPs are the primary mechanism for community members to propose three broad categories of changes to Chia's ecosystem:

Expand Down Expand Up @@ -141,7 +145,7 @@ The status of each CHIP will therefore fall into one of the following categories

A formal proposal has yet to be written, so it is not being tracked in the CHIP repository. All CHIPs start as _Ideas_.

In this stage of development, you should vet your idea in the #chia_dev channel on our [Keybase](https://keybase.io/team/chia_network.public "Chia's Keybase forum") forum. Be sure to gain general agreement from the community that your idea is:
In this stage of development, you should vet your idea in the #chips channel on our [Discord](https://discord.gg/chia "Chia's Discord server"). Be sure to gain general agreement from the community that your idea is:
* Original -- It has not been implemented or rejected previously.
* Valuable -- It would help Chia's community and/or ecosystem (and not just the author) if it were implemented.
* Narrow -- It focuses on a single key proposal.
Expand All @@ -158,13 +162,13 @@ Only _after_ your idea has met these conditions within the community, you may pr

When you are ready for your proposal to be moved into _Draft_, you should fill out the standard [template](/chip-template.md) and submit it as a pull request in the [CHIPs GitHub repository](https://github.com/Chia-Network/chips/ "CHIPs GitHub repository"). Your CHIP file should be formatted in markdown, and it should be named using this convention: `chip-<your name>-<your proposal>`.

Be as thorough as possible when filling out the template. Additional details may be added as the review moves forward, but to give your proposal the highest chance of success, it's important to include all relevant information from the beginning. Upon receiving your pull request, a CHIP Editor will make an initial assessment. If you do not hear from an Editor within one week of submitting your pull request, please post a message in the #chips channel of [Chia's Keybase forum](https://keybase.io/team/chia_network.public "Chia's Keybase forum").
Be as thorough as possible when filling out the template. Additional details may be added as the review moves forward, but to give your proposal the highest chance of success, it's important to include all relevant information from the beginning. Upon receiving your pull request, a CHIP Editor will make an initial assessment. If you do not hear from an Editor within one week of submitting your pull request, please post a message in the #chips channel of [Chia's Discord](https://discord.gg/chia).

If your proposal contains all of the necessary material, the Editor will assign it a number.

>Note that you should _not_ attempt to assign a number to your own CHIP.
At this point, your CHIP is a _Draft_. You'll need to present it to the community, using the aforementioned Keybase forum for less formal discussion, and your pull request for more formal comments. It is your responsibility to invite editors, developers, and other interested parties to review your draft, make comments, request changes, and give general feedback.
At this point, your CHIP is a _Draft_. You'll need to present it to the community, using the aforementioned Discord for less formal discussion, and your pull request for more formal comments. It is your responsibility to invite editors, developers, and other interested parties to review your draft, make comments, request changes, and give general feedback.

You will also need to gauge interest in your proposal, as well as figure out how broad the impact will be on Chia's ecosystem if it is implemented. In general, the larger your CHIP's impact (in both breadth and depth), the higher the threshold to gaining approval.

Expand Down Expand Up @@ -240,19 +244,18 @@ If you simply disagree with a CHIP's goals, you are not allowed to pursue a tran
### CHIP comments
The CHIP's _Comments-URI_ field will be the official location for the community to make comments and add reviews for the CHIP. This site is meant for formal and professional reviews and commentary only. The CHIP Editor will periodically review the content of this site and remove any postings not deemed sufficiently professional. Along those lines, everyone who adds a comment or review to this site is required to include their name and the current date. The Editor will contact them with any questions or clarifications.

Additionally, informal reviews and comments are welcome in the #chia_dev channel of Chia's [Keybase](https://keybase.io/team/chia_network.public "Chia's Keybase forum") forum. These comments will receive significantly less moderation. In fact, we encourage you to use this forum to introduce yourself to the community.
Additionally, informal reviews and comments are welcome in the #chia_dev channel of Chia's [Discord](https://discord.gg/chia). These comments will receive significantly less moderation. In fact, we encourage you to use this forum to introduce yourself to the community.

### CHIP editors

Name | Keybase Handle | GitHub Profile
:-----------------|:-----------------------------------------------------|:--------------
Bram Cohen | [@bramcohen](https://keybase.io/bramcohen) | [bramcohen](https://github.com/bramcohen)
Gene Hoffman, Jr. | [@hoffmang](https://keybase.io/hoffmang) | [hoffmang9](https://github.com/hoffmang9)
Paul Hainsworth | [@paulhainsworth](https://keybase.io/paulhainsworth) | [paulhainsworth-chia](https://github.com/paulhainsworth-chia)
Dan Perry | [@dan_perry](https://keybase.io/dan_perry) | [danieljperry](https://github.com/danieljperry)
Freddie Coleman | [@fcoleman](https://keybase.io/fcoleman) | [freddiecoleman](https://github.com/freddiecoleman)
Will Riches | [@riches](https://keybase.io/riches) | [wriches](https://github.com/wriches)
Andreas Greimel | [@acevail](https://keybase.io/acevail) | [greimela](https://github.com/greimela)
Name | Keybase Handle | Discord Handle | GitHub Profile
:-----------------|:-------------------------------------------|:----------------|:--------------
Bram Cohen | [@bramcohen](https://keybase.io/bramcohen) | bram_cohen | [bramcohen](https://github.com/bramcohen)
Gene Hoffman, Jr. | [@hoffmang](https://keybase.io/hoffmang) | hoffmang | [hoffmang9](https://github.com/hoffmang9)
Dan Perry | [@dan_perry](https://keybase.io/dan_perry) | danperry | [danieljperry](https://github.com/danieljperry)
Freddie Coleman | [@fcoleman](https://keybase.io/fcoleman) | freddiec12_381 | [freddiecoleman](https://github.com/freddiecoleman)
Will Riches | [@riches](https://keybase.io/riches) | wriches | [wriches](https://github.com/wriches)
Andreas Greimel | [@acevail](https://keybase.io/acevail) | acevail | [greimela](https://github.com/greimela)

### CHIP Editor responsibilities and workflow
When a pull request is created for a new CHIP, an Editor must review the template for:
Expand All @@ -268,7 +271,7 @@ However, it is important to keep in mind that the Editor must remain a neutral a

After the Editor has determined that the CHIP is ready to be moved into _draft_, they will assign the CHIP with a number and send a message to the author, who will present it to the community for further discussion.

The Editor will also assign the CHIP with a comments URI, which, unless there is a good reason to do otherwise, will take the form "Comments-URI: https://github.com/Chia-Network/chips/wiki/Comments:CHIP-WXYZ".
The Editor will also assign the CHIP with a comments URI, which, unless there is a good reason to do otherwise, will take the form "Comments-URI: [CHIPs repo, PR #000](https://github.com/Chia-Network/chips/pull/000)".

As detailed in the "CHIP categories and sub-categories" section above, the Editor (and not the Author) is responsible for changing the CHIP's status.

Expand All @@ -293,6 +296,8 @@ The authors of these documents are not responsible for the CHia Improvement Proc

[Chialisp's website](https://chialisp.com)

[Discord server](https://discord.gg/chia)

[Keybase forum](https://keybase.io/team/chia_network.public)

[CHIP pull requests](https://github.com/Chia-Network/chips/pulls)
Expand Down

0 comments on commit b096b57

Please sign in to comment.