Skip to content

Commit

Permalink
Merge pull request #75 from ethereumjs/org-links-and-git-hooks
Browse files Browse the repository at this point in the history
Org links and git hooks
  • Loading branch information
holgerd77 authored Apr 26, 2019
2 parents 2bdc87f + b678a97 commit f06a96f
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 0 deletions.
9 changes: 9 additions & 0 deletions .github/contributing.md
Original file line number Diff line number Diff line change
@@ -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! 👾 😀 💻
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,3 +50,9 @@ Run

The results are at
`coverage/lcov-report/index.html`

# 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).
6 changes: 6 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,11 @@
"test:fix": "npm run lint:fix && npm run unitTests",
"webtest": "browserify test/max.js | testling -u"
},
"husky": {
"hooks": {
"pre-push": "npm run lint"
}
},
"repository": {
"type": "git",
"url": "https://github.com/ethereumjs/rlp.git"
Expand Down Expand Up @@ -58,6 +63,7 @@
"@types/mocha": "^5.2.5",
"@types/node": "^10.12.2",
"coveralls": "^2.11.4",
"husky": "^2.1.0",
"mocha": "4.1.0",
"nyc": "^13.1.0",
"prettier": "^1.15.2",
Expand Down

0 comments on commit f06a96f

Please sign in to comment.