Skip to content
This repository was archived by the owner on Oct 30, 2024. It is now read-only.

Commit c04b80e

Browse files
authored
Merge pull request #88 from ethereumjs/org-links-and-git-hooks
Org links and git hooks
2 parents e896df6 + 18de4ec commit c04b80e

File tree

3 files changed

+21
-0
lines changed

3 files changed

+21
-0
lines changed

.github/contributing.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Contributing
2+
3+
Great that you want to contribute to the `EthereumJS` [ecosystem](https://ethereumjs.readthedocs.io/en/latest/introduction.html). `EthereumJS` is managed by the Ethereum Foundation and largely driven by the wider community. Everyone is welcome to join the effort and help to improve on the libraries (see our [Code of Conduct](https://ethereumjs.readthedocs.io/en/latest/code_of_conduct.html) 🌷).
4+
5+
We have written up some [Contribution Guidelines](https://ethereumjs.readthedocs.io/en/latest/contributing.html#how-to-start) to help you getting started.
6+
7+
These include information on how we work with **Git** and how our **general workflow** and **technical setup** looks like (stuff like language, tooling, code quality and style).
8+
9+
Happy Coding! 👾 😀 💻

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,12 @@ The following settings are favoured by the Go Ethereum implementation and we def
129129
- `p`: `1`
130130
- `cipher`: `aes-128-ctr`
131131

132+
# EthereumJS
133+
134+
See our organizational [documentation](https://ethereumjs.readthedocs.io) for an introduction to `EthereumJS` as well as information on current standards and best practices.
135+
136+
If you want to join for work or do improvements on the libraries have a look at our [contribution guidelines](https://ethereumjs.readthedocs.io/en/latest/contributing.html).
137+
132138
## License
133139

134140
MIT License

package.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,11 @@
1616
"test:build": "npm run build:dist && mocha ./test/*.js",
1717
"build:dist": "babel src/ -d ."
1818
},
19+
"husky": {
20+
"hooks": {
21+
"pre-push": "npm run lint"
22+
}
23+
},
1924
"repository": {
2025
"type": "git",
2126
"url": "https://github.com/ethereumjs/ethereumjs-wallet.git"
@@ -46,6 +51,7 @@
4651
"babel-cli": "^6.26.0",
4752
"babel-preset-env": "^1.7.0",
4853
"coveralls": "^3.0.0",
54+
"husky": "^2.1.0",
4955
"istanbul": "^0.4.5",
5056
"mocha": "^5.2.0",
5157
"standard": "^12.0.0"

0 commit comments

Comments
 (0)