From 72f629d502920e00258e400150f72cc26dd0159d Mon Sep 17 00:00:00 2001 From: holgerd77 Date: Fri, 26 Apr 2019 15:09:51 +0200 Subject: [PATCH 1/3] Added contributing file to .github folder --- .github/contributing.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 .github/contributing.md diff --git a/.github/contributing.md b/.github/contributing.md new file mode 100644 index 0000000..17ad370 --- /dev/null +++ b/.github/contributing.md @@ -0,0 +1,9 @@ +# Contributing + +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) 🌷). + +We have written up some [Contribution Guidelines](https://ethereumjs.readthedocs.io/en/latest/contributing.html#how-to-start) to help you getting started. + +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). + +Happy Coding! 👾 😀 💻 From 799fa230178dfc732d0aa5d9cbc709d7f0a4c212 Mon Sep 17 00:00:00 2001 From: holgerd77 Date: Fri, 26 Apr 2019 15:10:19 +0200 Subject: [PATCH 2/3] Added EthereumJS footer with organization docs linking --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 7cf8851..2921c28 100644 --- a/README.md +++ b/README.md @@ -129,6 +129,12 @@ The following settings are favoured by the Go Ethereum implementation and we def - `p`: `1` - `cipher`: `aes-128-ctr` +# EthereumJS + +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 do improvements on the libraries have a look at our [contribution guidelines](https://ethereumjs.readthedocs.io/en/latest/contributing.html). + ## License MIT License From 18de4ecc2d82cdaaa9d03969d1bafc460369a846 Mon Sep 17 00:00:00 2001 From: holgerd77 Date: Fri, 26 Apr 2019 15:11:03 +0200 Subject: [PATCH 3/3] Added husky (Git hooks) dependency and pre-push hook to package.json --- package.json | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/package.json b/package.json index 16bbd88..ccda3d3 100644 --- a/package.json +++ b/package.json @@ -16,6 +16,11 @@ "test:build": "npm run build:dist && mocha ./test/*.js", "build:dist": "babel src/ -d ." }, + "husky": { + "hooks": { + "pre-push": "npm run lint" + } + }, "repository": { "type": "git", "url": "https://github.com/ethereumjs/ethereumjs-wallet.git" @@ -46,6 +51,7 @@ "babel-cli": "^6.26.0", "babel-preset-env": "^1.7.0", "coveralls": "^3.0.0", + "husky": "^2.1.0", "istanbul": "^0.4.5", "mocha": "^5.2.0", "standard": "^12.0.0"