Skip to content

Commit

Permalink
Revamp github issue/PR config (ethereum#5066)
Browse files Browse the repository at this point in the history
* Create template for ERC4825

* It's 4829 apparently

* Forgot that field was there

* Undo all changes in _config.yml

* Rename LICENSE to LICENSE.md

* Test: add preamble

* Propose contact links to reduce the number of issues made in error

* Create config.yml

* Revamp some configstuff

* Few more changes I'm testing

* Undo that merge

* This is surprisingly annoying

* I'll just keep it this way

* Rephrase Ethereum Magicians

Co-authored-by: Micah Zoltu <micah@zoltu.net>

* Rephrase EIP Bot issues

Co-authored-by: Micah Zoltu <micah@zoltu.net>

* Rephrase eipv issues

Co-authored-by: Micah Zoltu <micah@zoltu.net>

* Remove eipip link

* Replace w/ absolute link

* Update issue templates

* Rename do-you-want-to-propose-a-change-to-the-eip-process-itself-.md to propose-process-change.md

* Delete custom.md

Co-authored-by: Micah Zoltu <micah@zoltu.net>
  • Loading branch information
2 people authored and nachomazzara committed Jan 13, 2023
1 parent 4930535 commit cff620c
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 3 deletions.
3 changes: 3 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Please review [EIP-1](https://eips.ethereum.org/EIPS/eip-1) for EIP guidelines.

<!-- RATIONALE FOR THIS FILE: IT IS DISPLAYED WHEN YOU CREATE AN ISSUE OR MAKE A PR -->
5 changes: 2 additions & 3 deletions ISSUE_TEMPLATE.md → .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@

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):
Keep in mind the following guidelines from [EIP-1](https://eips.ethereum.org/EIPS/eip-1):

> 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 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.
> 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.
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
blank_issues_enabled: true
contact_links:
- name: Do you want to discuss EIP ideas or ask questions about the process?
url: https://ethereum-magicians.org/
about: Use the Fellowship of Ethereum Magicians for EIP-related discussion!
- name: Do you want to submit a bug report for one of the GitHub action bots (not Travis CI)?
url: https://github.com/ethereum/EIP-Bot/issues
about: If you have a problem with the EIP Bot, report it here!
- name: Do you want to submit a bug report for the validation bot (Travis CI)?
url: https://github.com/ethereum/eipv/issues
about: If you have a problem with EIP Validation, report it here!
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/propose-process-change.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
name: Do you want to propose a change to the EIP process itself?
about: Use this if you want to propose changes to the EIP process
title: ''
labels: enhancement
assignees: ''

---

Describe your proposed change here.
File renamed without changes.

0 comments on commit cff620c

Please sign in to comment.