Skip to content

docs: translate document to help read #1281

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
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
76 changes: 76 additions & 0 deletions docs/how-to-add-proposal-to-etereum-community-en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# How to Submit a Proposal to the Ethereum Community

## Preface

+ The Ethereum community needs to be built, and early builders will receive real value in return.
+ Much of the creativity of other public chains relies on the Ethereum community, which is the vitality of the Ethereum community.
+ Besides trading tokens, supporting or participating in the planning and construction of the community is very valuable.
+ EIP (Ethereum Improvement Proposal) is used to discuss any interesting suggestions. EIP-721, which is NFT, is one of the EIPs, coming from Lara Labs.

## Resources

+ URL: https://github.com/ethereum/EIPs/issues/new
+ Template: https://github.com/ethereum/EIPs/blob/master/eip-template.md

## Notes

+ First, read EIP-1 in depth: https://eips.ethereum.org/EIPS/eip-1

+ Key points are listed below.

+ ATTENTION! If you would like to submit an EIP and it has already been written as a draft (see the [template](https://github.com/ethereum/EIPs/blob/master/eip-template.md) for an example), please submit it as a [Pull Request](https://github.com/ethereum/EIPs/pulls).

+ If you are considering a proposal but would like to get some feedback on the idea before submitting a draft, then continue opening an Issue as a thread for discussion. Note that the more clearly and completely you state your idea the higher the quality of the feedback you are likely to receive.

Keep in mind the following guidelines from [EIP-1](./eip-1.md):

> Each EIP must have a champion - someone who writes the EIP using the style and format described below, shepherds the discussions in the appropriate forums, and attempts to build community consensus around the idea. The EIP champion (a.k.a. Author) should first attempt to ascertain whether the idea is EIP-able. Posting to the Protocol Discussion forum or opening an Issue is the best way to go about this.

> Vetting an idea publicly before going as far as writing a EIP is meant to save the potential author time. Asking the Ethereum community first if an idea is original helps prevent too much time being spent on something that is guaranteed to be rejected based on prior discussions (searching the Internet does not always do the trick). It also helps to make sure the idea is applicable to the entire community and not just the author. Just because an idea sounds good to the author does not mean it will work for most people in most areas where Ethereum is used.

> Once the champion has asked the Ethereum community as to whether an idea has any chance of acceptance, a draft EIP should be presented as a Pull Request. This gives the author a chance to flesh out the draft EIP to make properly formatted, of high quality, and to address initial concerns about the proposal.

## Explanation

+ A proposal first comes from some context and ideas, thoughts, most of which come from problems and difficulties encountered in actual work and development, finding that Ethereum needs to be improved.
+ For example, community projects participating in the metaverse construction process find that defining a set of standards would be more conducive to development. Contributing these standards to the community can help others improve efficiency and enhance interaction efficiency with each other.
+ The EIP submission process provides standards for how to explain things clearly and comprehensively.

### Discussion

+ First, there needs to be a champion, which is the main author.
+ Then discuss in the corresponding community, usually by creating an issue on GitHub (such as 721's https://github.com/ethereum/eips/issues/721) or a forum post: [the Ethereum Magicians forum](https://ethereum-magicians.org/).
+ The discussion process needs to ascertain whether the idea is EIP-able, whether it is worth and able to establish an EIP.
+ Additionally, before writing an EIP, it's best to publicly discuss the idea and ask the Ethereum community if it's feasible, which can prevent wasting too much time on unnecessary ideas.
+ PS: The readme of the Magicians forum: https://ethereum-magicians.org/t/welcome-please-readme-first/8, you'll find that it takes a lot of time to browse around and get familiar with the rules.
+ If after inquiring and discussing with the community, your post is considered to have a chance of acceptance, then submit a proposal draft.

### Draft

+ Fork the EIP repository, like I did: ![fork](https://tva1.sinaimg.cn/large/e6c9d24ely1h0ymse1599j21zw0g2acq.jpg)
+ Use the [template](https://github.com/ethereum/EIPs/blob/master/eip-template.md) to write your EIP. There are a lot of concepts in it, but just write it first.
+ After completing the draft, submit a Pull Request, yes, the legendary PR, haha.
+ After submission, it will be reviewed, such as Dr. Zhou's EIP4972: https://github.com/ethereum/EIPs/pull/4972

### Status

+ After submitting the PR, the core review group in the community: This PR requires review from one of [[@lightclient](https://github.com/lightclient), [@axic](https://github.com/axic), [@SamWilsn](https://github.com/SamWilsn)]
+ Repeatedly communicate about format and expression until the draft is merged, then it enters the EIP status list.
+ The status list is complex
+ [Status](https://github.com/qizhou/EIPs/blob/master/assets/eip-1/EIP-process-update.jpg)
+ The core is: Idea-->Draft-->Review<-->Last Call-->Final
+ Review will enter the Living state, with repeated iterations and modifications
+ It may also enter the Stagnant state.

### Other

+ Ethereum working PM meetings: https://github.com/ethereum/pm, including agenda, records, corresponding Twitter records, and videos.
+ For example, the record of the most recent meeting: https://github.com/ethereum/pm/blob/master/AllCoreDevs-Meetings/Meeting%20134.md
+ Progress on Kiln and beacon chain, etc. Currently, I'm not sure if one can add their own agenda and participate in meetings without invitation, it seems like you need to become a PM?
+ This article will be published in the Dapp Learning community: https://github.com/Dapp-Learning-DAO/Dapp-Learning, as well as personal Blog (jLab.tech)

## How to Write an EIP? See the Next Article




14 changes: 7 additions & 7 deletions docs/how-to-add-proposal-to-etereum-community.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ how-to-add-proposal-to-etereum-community
+ 除了炒币,支持或者参与创造到社区的规划和建设中来,是非常有价值的。
+ EIP是以太坊提升提案,用来讨论任何有意思的建议,EIP721也就是NFT是之EIP一,来自于Lara Labs。

### Resource
### 资源

+ URL:https://github.com/ethereum/EIPs/issues/new
+ 模板:https://github.com/ethereum/EIPs/blob/master/eip-template.md
Expand All @@ -19,17 +19,17 @@ how-to-add-proposal-to-etereum-community

+ 要点下面会列出。

+ ATTENTION! If you would like to submit an EIP and it has already been written as a draft (see the [template](https://github.com/ethereum/EIPs/blob/master/eip-template.md) for an example), please submit it as a [Pull Request](https://github.com/ethereum/EIPs/pulls).
+ 注意!如果您想提交一个EIP,并且已经将其写成草稿(参见[模板](https://github.com/ethereum/EIPs/blob/master/eip-template.md)作为示例),请将其作为[Pull Request](https://github.com/ethereum/EIPs/pulls)提交。

+ If you are considering a proposal but would like to get some feedback on the idea before submitting a draft, then continue opening an Issue as a thread for discussion. Note that the more clearly and completely you state your idea the higher the quality of the feedback you are likely to receive.
+ 如果您正在考虑一个提案,但希望在提交草稿之前获得关于这个想法的一些反馈,那么请继续开一个Issue作为讨论的线程。请注意,您陈述想法的越清晰和完整,您可能收到的反馈质量就越高。

Keep in mind the following guidelines from [EIP-1](./eip-1.md):
请记住[EIP-1](./eip-1.md)中的以下指导原则:

> Each EIP must have a champion - someone who writes the EIP using the style and format described below, shepherds the discussions in the appropriate forums, and attempts to build community consensus around the idea. The EIP champion (a.k.a. Author) should first attempt to ascertain whether the idea is EIP-able. Posting to the Protocol Discussion forum or opening an Issue is the best way to go about this.
> 每个EIP必须有一个倡导者 - 即使用下面描述的风格和格式撰写EIP,在适当的论坛中引导讨论,并尝试围绕这个想法建立社区共识的人。EIP倡导者(也称为作者)首先应该确定这个想法是否适合成为EIP。在协议讨论论坛上发帖或开一个Issue是最好的方式。

> Vetting an idea publicly before going as far as writing a EIP is meant to save the potential author time. Asking the Ethereum community first if an idea is original helps prevent too much time being spent on something that is guaranteed to be rejected based on prior discussions (searching the Internet does not always do the trick). It also helps to make sure the idea is applicable to the entire community and not just the author. Just because an idea sounds good to the author does not mean it will work for most people in most areas where Ethereum is used.
> 在写EIP之前公开审查一个想法是为了节省潜在作者的时间。首先询问以太坊社区一个想法是否原创,有助于防止在保证会被拒绝的事情上花费太多时间(搜索互联网并不总是能解决问题)。这也有助于确保这个想法适用于整个社区,而不仅仅是作者。仅仅因为一个想法对作者来说听起来不错,并不意味着它对大多数使用以太坊的人在大多数领域都有效。

> Once the champion has asked the Ethereum community as to whether an idea has any chance of acceptance, a draft EIP should be presented as a Pull Request. This gives the author a chance to flesh out the draft EIP to make properly formatted, of high quality, and to address initial concerns about the proposal.
> 一旦倡导者已经询问了以太坊社区关于一个想法是否有被接受的可能性,就应该以Pull Request的形式提交一个EIP草稿。这给了作者一个机会来充实EIP草稿,使其格式正确,质量高,并解决关于提案的初步担忧。

### 解释

Expand Down