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.

Sign up for GitHub

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

Jump to bottom

added prerequisites requirement for pages subject to change #250

Merged
merged 3 commits into from
May 3, 2024
Merged

added prerequisites requirement for pages subject to change #250

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9295c96
added prerequisites requirement for pages subject to change
gorondan May 2, 2024
adf743e
nit: title
raxhvl May 3, 2024
511cf25
Update contributing.md
taxmeifyoucan May 3, 2024
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
15 changes: 15 additions & 0 deletions docs/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,21 @@ Usage of images and visualizations is encouraged. If you are using an image crea

Feel free to use [emojis](https://docsify.js.org/#/emoji?id=emoji) or [icons](https://icongr.am/fontawesome) where it fits, for example in blockquotes.

### Prerequisites
Wiki pages that are subject to future updates, i.e. pages covering active research topics require prerequisites to be added on top of the pages:
raxhvl marked this conversation as resolved.
Show resolved Hide resolved

* Warning message artifact using the following format:
> [!WARNING]
> This document covers an active area of research, may be outdated at time of reading and subject to future updates, as the design space around (*active research topic, e.g. Inclusion Lists*) evolves.

* Roadmap tracker artifact using the following format:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Roadmap tracker artifact using the following format:
#### Rodmap format
Roadmap tracker artifact using the following format:

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One thing about roadmap tracker: if we go for the proposed changes, it's not clear imo if the tracker should be added to all pages or just to research pages(acc. to this discussion). That's why in the initial commit, both artifacts were presented under research pages


| Upgrade | URGE | Track | Topic | Cross-references |
| :-------: | :---------: | :-------: | :-------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| *e.g. ePBS* | the Scourge | MEV track | Endgame block production pipeline | intersection with: [ET](https://ethresear.ch/t/execution-tickets/17944), [PEPC](https://efdn.notion.site/PEPC-FAQ-0787ba2f77e14efba771ff2d903d67e4), [IL](https://eips.ethereum.org/EIPS/eip-7547) |

Ideally, links in artifacts will reference local wiki pages.

### Linking resources

When adding an external link, you can use it directly in the text or on the bottom of the page in "Resources" section.
Expand Down
Loading