Skip to content

docs(router): update #40

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 2 commits into
base: master
Choose a base branch
from
Open
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
3 changes: 0 additions & 3 deletions .gitmodules

This file was deleted.

17 changes: 15 additions & 2 deletions .prettierrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ module.exports = {
arrowParens: 'always',
bracketSpacing: true,
endOfLine: 'lf',
jsxBracketSameLine: false,
jsxSingleQuote: false,
printWidth: 120,
proseWrap: 'never',
quoteProps: 'as-needed',
Expand All @@ -14,4 +12,19 @@ module.exports = {
tabWidth: 2,
trailingComma: 'all',
useTabs: false,
semi: true,
overrides: [
{
files: '*.md',
options: {
parser: 'markdown',
proseWrap: 'preserve',
printWidth: 100,
tabWidth: 4,
useTabs: false,
singleQuote: false,
bracketSpacing: true,
},
},
],
};
64 changes: 32 additions & 32 deletions docs/Contributing-Guidelines.md
Original file line number Diff line number Diff line change
@@ -1,67 +1,68 @@
---
title: Contributing and Community Guidelines
title: Contributing and Community Guidelines
version: v2022.06.26
author: The OpenMEV Contributors
license: CC-SA-3.0
---

# OpenMEV Contributing and Community Guidelines

- [OpenMEV Contributing and Community Guidelines](#openmev-contributing-and-community-guidelines)
* [Preface](#preface)
* [Motivation](#motivation)
* [Principles](#principles)
+ [Pro Community](#pro-community)
+ [Pro Professionalism](#pro-professionalism)
+ [The Ethereum Ecosystem](#the-ethereum-ecosystem)
* [Social Rules](#social-rules)
+ [Why have social rules?](#why-have-social-rules)
* [License](#license)
* [Citations / Attributions](#citations)
- [OpenMEV Contributing and Community Guidelines](#openmev-contributing-and-community-guidelines)
- [Preface](#preface)
- [Motivation](#motivation)
- [Principles](#principles)
- [Pro Community](#pro-community)
- [Pro Professionalism](#pro-professionalism)
- [The Ethereum Ecosystem](#the-ethereum-ecosystem)
- [Social Rules](#social-rules)
- [Why have social rules?](#why-have-social-rules)
- [License](#license)
- [Citations / Attributions](#citations)

## Preface

This document is **largely** taken from/inspired by John A. De Goes. More specifically, the articles, ["ZIO Professionalism"](https://degoes.net/articles/zio-professionalism), ["Big Tent"](https://degoes.net/articles/big-tent), and ["Travis Brown, Abuser"](https://degoes.net/articles/travis-brown-abuser). Without his insight, this guideline would not be where it is today.

## Motivation

OpenMEV supports the right of every OSS engineer/developer to contribute on their terms, whatever those terms may be. Non-paying users of free software should not get to dictate these terms. Moreover, OpenMEV's stated objective of being a credible neutral org means that we must formalize a Contributing Guideline so that as it expands, there is a codified expectation of behavior from any and all contributors.
OpenMEV supports the right of every OSS engineer/developer to contribute on their terms, whatever those terms may be. Non-paying users of free software should not get to dictate these terms. Moreover, OpenMEV's stated objective of being a credible neutral org means that we must formalize a Contributing Guideline so that as it expands, there is a codified expectation of behavior from any and all contributors.

## Principles

We must recognize that the actions of other organizations, protocols, etc. may have undesirable side effects on the OpenMEV community (and Ethereum at large):

- They undermine the trust that end-users and companies place in Ethereum
- They increase the risk involved in deploying solutions based on Ethereum
- They decrease the network value of Ethereum
- They make OpenMEV look unprofessional to many developers, especially compared within the Ethereum/other ecosystems where major OSS projects would never behave in such a fashion
- They undermine the trust that end-users and companies place in Ethereum
- They increase the risk involved in deploying solutions based on Ethereum
- They decrease the network value of Ethereum
- They make OpenMEV look unprofessional to many developers, especially compared within the Ethereum/other ecosystems where major OSS projects would never behave in such a fashion

Effective immediately, OpenMEV shall codify and will support the following:

### Pro Community

- **Pro-Community**. All OpenMEV projects will gladly accept and host integrations for Flashbots, Eden Network, and other MEV or EVM ecosystems, without consideration of the relationships, dispositions, or politics between these projects and those ecosystems, and they will provide non-discriminatory support for end-users, regardless of their disposition to or affiliation or association with other OpenMEV community members or ecosystems.

- _pro-community_, as OpenMEV hosts integrations for Sushiswap projects _swaps_ and _bentobox_, and hosts integrations for _OlympusDAO_,_LayerZero_ to date. Conflicting incentives should be considered and debated if it is possible that adding support for another project would conflict with existing integrations. However, I believe that making this behavior official will further increase trust and expand integrations, and also clearly set expectations for new projects being integrated into the OpenMEV solution sets.
- _pro-community_, as OpenMEV hosts integrations for Sushiswap projects *swaps* and *bentobox*, and hosts integrations for *OlympusDAO*,_LayerZero_ to date. Conflicting incentives should be considered and debated if it is possible that adding support for another project would conflict with existing integrations. However, I believe that making this behavior official will further increase trust and expand integrations, and also clearly set expectations for new projects being integrated into the OpenMEV solution sets.

### Pro Professionalism
### Pro Professionalism

- **Pro-Professionalism**. Although behavior within the OpenMEV organization projects is already governed by the [OpenMEV Code of Conduct](#), I want to strengthen this code of conduct by making it clear that ad hominem and career sabotage have no place within the community. Projects in the OpenMEV organization exist only to help engineers and developers solve problems, regardless of their religion, political affiliation, race, or disposition to or affiliation or association with other OpenMEV community members or ecosystems.

_pro-professionalism_, within OpenMEV official spaces (Github, Discourse, etc.), I have only ever seen welcoming, inclusive, and non-discriminatory behavior, without ad hominem or career sabotage. But explicitly committing to this high standard of professionalism can only help to set expectations and provide guidance for everyone as the organization continues to grow.
*pro-professionalism*, within OpenMEV official spaces (Github, Discourse, etc.), I have only ever seen welcoming, inclusive, and non-discriminatory behavior, without ad hominem or career sabotage. But explicitly committing to this high standard of professionalism can only help to set expectations and provide guidance for everyone as the organization continues to grow.

### The Ethereum Ecosystem
### The Ethereum Ecosystem

It is not necessary that open source contributors have the same views or even like each other. We must put Ethereum first, and by being pro-community and pro-professionalism, we can find a way to co-exist peacefully inside this big tent, and together, we can, in different ways and with different audiences, show the world that Ethereum is a force to reckon with.

## Social Rules

[These rules are adopted from recurse.com/manual#sec-environment](https://www.recurse.com/manual#sec-environment)

- No well-actually's
- No feigning surprise
- No back-seat driving
- No subtle -isms
- Remember that everyone was new to Ethereum at some point.
- No well-actually's
- No feigning surprise
- No back-seat driving
- No subtle -isms
- Remember that everyone was new to Ethereum at some point.

### Why have social rules?

Expand All @@ -71,16 +72,15 @@ These rules are designed to help all of us build a pleasant, productive, and rob

This document is distributed under a [Creative Commons Attribution-ShareAlike license](https://creativecommons.org/licenses/by-sa/3.0/).


## Citations

> Citations and Attributions

The Recurse Community, https://www.recurse.com/about; 2022 June 10 <br />
The Scala Community, https://scala-lang.org/conduct/; 2022 June 10 <br />
The ZIO Community, https://github.com/zio; 2022 June 10 <br />
The Rust Code of Conduct, https://www.rust-lang.org/policies/code-of-conduct 2022 June 10 <br />
The ZIO Community, https://github.com/zio; 2022 June 10 <br />
The Rust Code of Conduct, https://www.rust-lang.org/policies/code-of-conduct 2022 June 10 <br />
The Node.js Policy on Trolling, https://blog.izs.me/post/30036893703/policy-on-trolling <br />
["ZIO Professionalism"](https://degoes.net/articles/zio-professionalism), 2022 June 10 <br />
["Big Tent"](https://degoes.net/articles/big-tent). 2022 June 10 <br />
["Travis Brown, Abuser"](https://degoes.net/articles/travis-brown-abuser). 2022 June 10 <br />
["ZIO Professionalism"](https://degoes.net/articles/zio-professionalism), 2022 June 10 <br />
["Big Tent"](https://degoes.net/articles/big-tent). 2022 June 10 <br />
["Travis Brown, Abuser"](https://degoes.net/articles/travis-brown-abuser). 2022 June 10 <br />
35 changes: 0 additions & 35 deletions docs/Ethereum-API/eth_getTransactionCount.md

This file was deleted.

Loading