Development: Improve onboarding experience for new contributors (#46)

WordPress · Nov 28, 2017 · 4ad0565 · 4ad0565
1 parent 12b5c6c
commit 4ad0565
Show file tree

Hide file tree

Showing 6 changed files with 119 additions and 25 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -5,7 +5,6 @@ node_js:
   - '6'
 
 script:
-  - lerna bootstrap && npm run build
   - npm run test:coverage-ci
 
 notifications:

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -12,8 +12,35 @@ Ideally name your branches with prefixes and descriptions, like this: `[type]/[c
 
 For example, `add/foo-module` means you're working on adding a new foo module.
 
-You can pick among all the <a href="https://github.com/WordPress/packages/issues">tickets</a>, or some of the ones labelled <a href="https://github.com/WordPress/packages/labels/Good%20First%20Task">Good First Task</a>.
+You can pick among all the <a href="https://github.com/WordPress/packages/issues">issues</a>, or some of the ones labelled <a href="https://github.com/WordPress/packages/labels/Good%20First%20Issue">Good First Issue</a>.
 
+## Developing
+
+Packages is built for Node 6 and up. You can check this with `node -v`.
+
+Make sure that npm is installed with version >= `5.0.0` using `npm -v`.
+
+### Setup
+
+```sh
+$ git clone https://github.com/WordPress/packages.git
+$ cd packages
+$ npm install
+```
+
+### Testing
+
+In order to run the tests:
+
+```sh
+$ npm test
+
+# If you want to watch for changes
+$ npm run test:watch
+
+# If you want to check code coverage
+$ npm run test:coverage
+```
 
 ## Releasing
 

diff --git a/README.md b/README.md
@@ -2,5 +2,13 @@
 
 [![Build Status](https://img.shields.io/travis/WordPress/packages/master.svg)](https://travis-ci.org/WordPress/packages)
 [![Coverage](https://img.shields.io/codecov/c/github/WordPress/packages/master.svg)](https://codecov.io/gh/WordPress/packages)
+[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lernajs.io/)
 
-Collection of JS modules and tools for WordPress development available at https://www.npmjs.com/org/wordpress
+Collection of JS modules and tools for WordPress development available at https://www.npmjs.com/org/wordpress.
+
+### Want to contribute to packages?
+
+Check out our [CONTRIBUTING.md](CONTRIBUTING.md) to get started with setting up the repo.
+
+- If you have already joined Slack, join our [#core-js](https://wordpress.slack.com/messages/core-js) channel and say hi!
+- Check out the issues with the [good first issue](https://github.com/WordPress/packages/labels/Good%20First%20Issue) and [help wanted](https://github.com/WordPress/packages/labels/help%20wanted) label. We suggest also looking at the closed ones to get a sense of the kinds of issues you can tackle.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -24,6 +24,7 @@
   "scripts": {
     "build-clean": "rimraf ./packages/*/build ./packages/*/build-module",
     "build": "node ./scripts/build.js",
+    "postinstall": "lerna bootstrap --hoist && npm run build",
     "test": "jest",
     "test:coverage": "jest --coverage",
     "test:coverage-ci": "jest --coverage && codecov",

diff --git a/packages/hooks/package.json b/packages/hooks/package.json
@@ -8,7 +8,6 @@
   "description": "WordPress Hooks library",
   "main": "build/index.js",
   "module": "build-module/index.js",
-  "browser": "build-browser/index.js",
   "author": "WordPress",
   "license": "GPL-2.0+",
   "publishConfig": {