Skip to content

Commit 5eaf56a

Browse files
authored
Update README EthereumJS Footers (#4081)
* Add code of conduct (ported over from old ReadTheDocs documentation) * Update EthereumJS footers on README files
1 parent 88f0560 commit 5eaf56a

File tree

19 files changed

+103
-18
lines changed

19 files changed

+103
-18
lines changed

CODE_OF_CONDUCT.md

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
2+
# Code of Conduct
3+
4+
## Table of Contents
5+
6+
- [Our Pledge](#our-pledge)
7+
- [Our Standards](#our-standards)
8+
- [Our Responsibilities](#our-responsibilities)
9+
- [Scope](#scope)
10+
- [Enforcement](#enforcement)
11+
- [Attribution](#attribution)
12+
13+
## Our Pledge
14+
15+
In the interest of fostering an open and welcoming environment, we as
16+
contributors and maintainers pledge to making participation in our project and
17+
our community a harassment-free experience for everyone, regardless of age, body
18+
size, disability, ethnicity, gender identity and expression, level of experience,
19+
education, socio-economic status, nationality, personal appearance, race,
20+
religion, or sexual identity and orientation.
21+
22+
## Our Standards
23+
24+
Examples of behavior that contributes to creating a positive environment
25+
include:
26+
27+
- Using welcoming and inclusive language
28+
- Being respectful of differing viewpoints and experiences
29+
- Gracefully accepting constructive criticism
30+
- Focusing on what is best for the community
31+
- Showing empathy towards other community members
32+
33+
Examples of unacceptable behavior by participants include:
34+
35+
- The use of sexualized language or imagery and unwelcome sexual attention or
36+
advances
37+
- Trolling, insulting/derogatory comments, and personal or political attacks
38+
- Public or private harassment
39+
- Publishing others' private information, such as a physical or electronic
40+
address, without explicit permission
41+
- Other conduct which could reasonably be considered inappropriate in a
42+
professional setting
43+
44+
## Our Responsibilities
45+
46+
Project maintainers are responsible for clarifying the standards of acceptable
47+
behavior and are expected to take appropriate and fair corrective action in
48+
response to any instances of unacceptable behavior.
49+
50+
Project maintainers have the right and responsibility to remove, edit, or
51+
reject comments, commits, code, wiki edits, issues, and other contributions
52+
that are not aligned to this Code of Conduct, or to ban temporarily or
53+
permanently any contributor for other behaviors that they deem inappropriate,
54+
threatening, offensive, or harmful.
55+
56+
## Scope
57+
58+
This Code of Conduct applies both within project spaces and in public spaces
59+
when an individual is representing the project or its community. Examples of
60+
representing a project or community include using an official project e-mail
61+
address, posting via an official social media account, or acting as an appointed
62+
representative at an online or offline event. Representation of a project may be
63+
further defined and clarified by project maintainers.
64+
65+
## Enforcement
66+
67+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
68+
reported by contacting the project team at [email protected]. All
69+
complaints will be reviewed and investigated and will result in a response that
70+
is deemed necessary and appropriate to the circumstances. The project team is
71+
obligated to maintain confidentiality with regard to the reporter of an incident.
72+
Further details of specific enforcement policies may be posted separately.
73+
74+
Project maintainers who do not follow or enforce the Code of Conduct in good
75+
faith may face temporary or permanent repercussions as determined by other
76+
members of the project's leadership.
77+
78+
## Attribution
79+
80+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4,
81+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ To update the diagram above edit the README file and open a new PR with the chan
155155

156156
## EthereumJS
157157

158-
See our organizational [documentation](https://ethereumjs.readthedocs.io) for an introduction to `EthereumJS` as well as information on current standards and best practices. If you want to join for work or carry out improvements on the libraries, please review our [contribution guidelines](https://ethereumjs.readthedocs.io/en/latest/contributing.html) first.
158+
The `EthereumJS` GitHub organization and its repositories are managed by the Ethereum Foundation JavaScript team, see our [website](https://ethereumjs.github.io/) for a team introduction. If you want to join for work or carry out improvements on the libraries see the [developer docs](./DEVELOPER.md) for an overview of current standards and tools and review our [code of conduct](./CODE_OF_CONDUCT.md).
159159

160160
## License
161161

packages/binarytree/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ npm install @ethereumjs/binarytree
2828
```
2929
## EthereumJS
3030

31-
See our organizational [documentation](https://ethereumjs.readthedocs.io) for an introduction to `EthereumJS` as well as information on current standards and best practices. If you want to join for work or carry out improvements on the libraries, please review our [contribution guidelines](https://ethereumjs.readthedocs.io/en/latest/contributing.html) first.
31+
The `EthereumJS` GitHub organization and its repositories are managed by the Ethereum Foundation JavaScript team, see our [website](https://ethereumjs.github.io/) for a team introduction. If you want to join for work or carry out improvements on the libraries see the [developer docs](../../DEVELOPER.md) for an overview of current standards and tools and review our [code of conduct](../../CODE_OF_CONDUCT.md).
3232

3333
## License
3434

packages/block/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -411,7 +411,7 @@ To avoid bloating this repository with [ethereum/tests](https://github.com/ether
411411

412412
## EthereumJS
413413

414-
See our organizational [documentation](https://ethereumjs.readthedocs.io) for an introduction to `EthereumJS` as well as information on current standards and best practices. If you want to join for work or carry out improvements on the libraries, please review our [contribution guidelines](https://ethereumjs.readthedocs.io/en/latest/contributing.html) first.
414+
The `EthereumJS` GitHub organization and its repositories are managed by the Ethereum Foundation JavaScript team, see our [website](https://ethereumjs.github.io/) for a team introduction. If you want to join for work or carry out improvements on the libraries see the [developer docs](../../DEVELOPER.md) for an overview of current standards and tools and review our [code of conduct](../../CODE_OF_CONDUCT.md).
415415

416416
## License
417417

packages/blockchain/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -252,7 +252,7 @@ Additional log selections can be added with a comma separated list (no spaces).
252252

253253
## EthereumJS
254254

255-
See our organizational [documentation](https://ethereumjs.readthedocs.io) for an introduction to `EthereumJS` as well as information on current standards and best practices. If you want to join for work or carry out improvements on the libraries, please review our [contribution guidelines](https://ethereumjs.readthedocs.io/en/latest/contributing.html) first.
255+
The `EthereumJS` GitHub organization and its repositories are managed by the Ethereum Foundation JavaScript team, see our [website](https://ethereumjs.github.io/) for a team introduction. If you want to join for work or carry out improvements on the libraries see the [developer docs](../../DEVELOPER.md) for an overview of current standards and tools and review our [code of conduct](../../CODE_OF_CONDUCT.md).
256256

257257
## License
258258

packages/common/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -371,7 +371,7 @@ The following EIPs are currently supported:
371371

372372
## EthereumJS
373373

374-
See our organizational [documentation](https://ethereumjs.readthedocs.io) for an introduction to `EthereumJS` as well as information on current standards and best practices. If you want to join for work or carry out improvements on the libraries, please review our [contribution guidelines](https://ethereumjs.readthedocs.io/en/latest/contributing.html) first.
374+
The `EthereumJS` GitHub organization and its repositories are managed by the Ethereum Foundation JavaScript team, see our [website](https://ethereumjs.github.io/) for a team introduction. If you want to join for work or carry out improvements on the libraries see the [developer docs](../../DEVELOPER.md) for an overview of current standards and tools and review our [code of conduct](../../CODE_OF_CONDUCT.md).
375375

376376
## License
377377

packages/devp2p/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -464,7 +464,7 @@ The following is a list of major implementations of the `devp2p` stack in other
464464
465465
## EthereumJS
466466
467-
See our organizational [documentation](https://ethereumjs.readthedocs.io) for an introduction to `EthereumJS` as well as information on current standards and best practices. If you want to join for work or carry out improvements on the libraries, please review our [contribution guidelines](https://ethereumjs.readthedocs.io/en/latest/contributing.html) first.
467+
The `EthereumJS` GitHub organization and its repositories are managed by the Ethereum Foundation JavaScript team, see our [website](https://ethereumjs.github.io/) for a team introduction. If you want to join for work or carry out improvements on the libraries see the [developer docs](../../DEVELOPER.md) for an overview of current standards and tools and review our [code of conduct](../../CODE_OF_CONDUCT.md).
468468
469469
## License
470470

packages/e2store/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -277,7 +277,7 @@ console.log('slotIndex', {
277277
278278
## EthereumJS
279279
280-
See our organizational [documentation](https://ethereumjs.readthedocs.io) for an introduction to `EthereumJS` as well as information on current standards and best practices. If you want to join for work or carry out improvements on the libraries, please review our [contribution guidelines](https://ethereumjs.readthedocs.io/en/latest/contributing.html) first.
280+
The `EthereumJS` GitHub organization and its repositories are managed by the Ethereum Foundation JavaScript team, see our [website](https://ethereumjs.github.io/) for a team introduction. If you want to join for work or carry out improvements on the libraries see the [developer docs](../../DEVELOPER.md) for an overview of current standards and tools and review our [code of conduct](../../CODE_OF_CONDUCT.md).
281281
282282
## License
283283

packages/ethash/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ Using ESM will give you additional advantages over CJS beyond browser usage like
112112

113113
## EthereumJS
114114

115-
See our organizational [documentation](https://ethereumjs.readthedocs.io) for an introduction to `EthereumJS` as well as information on current standards and best practices. If you want to join for work or carry out improvements on the libraries, please review our [contribution guidelines](https://ethereumjs.readthedocs.io/en/latest/contributing.html) first.
115+
The `EthereumJS` GitHub organization and its repositories are managed by the Ethereum Foundation JavaScript team, see our [website](https://ethereumjs.github.io/) for a team introduction. If you want to join for work or carry out improvements on the libraries see the [developer docs](../../DEVELOPER.md) for an overview of current standards and tools and review our [code of conduct](../../CODE_OF_CONDUCT.md).
116116

117117
## License
118118

packages/evm/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -485,7 +485,7 @@ See [@ethereumjs/vm](https://github.com/ethereumjs/ethereumjs-monorepo/tree/mast
485485

486486
## EthereumJS
487487

488-
See our organizational [documentation](https://ethereumjs.readthedocs.io) for an introduction to `EthereumJS` as well as information on current standards and best practices. If you want to join for work or carry out improvements on the libraries, please review our [contribution guidelines](https://ethereumjs.readthedocs.io/en/latest/contributing.html) first.
488+
The `EthereumJS` GitHub organization and its repositories are managed by the Ethereum Foundation JavaScript team, see our [website](https://ethereumjs.github.io/) for a team introduction. If you want to join for work or carry out improvements on the libraries see the [developer docs](../../DEVELOPER.md) for an overview of current standards and tools and review our [code of conduct](../../CODE_OF_CONDUCT.md).
489489

490490
## License
491491

0 commit comments

Comments
 (0)