Skip to content

Commit 20068bb

Browse files
authored
add contributing guide
1 parent ee8897a commit 20068bb

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -181,5 +181,15 @@ render() {
181181

182182
Check out [bokuweb/re-resizable](https://github.com/bokuweb/re-resizable). Wrapping your component with `<Resizable/>'s` works well
183183

184+
## Contributing
185+
186+
Pull Requests are welcome. Be mindful of the availbe scripts below to help submitting a well-received contribution.
187+
188+
- `npm run start` to run the app on `localhost:8000`
189+
- `npm run webpack` to re-bundle the react app
190+
- `npm run test` to ensure tests continue to pass
191+
- `npm run build` to generate the demo bundle
192+
193+
* note that it's necessary to bump the [package.json](https://github.com/scniro/react-codemirror2/blob/master/package.json#L3) version prior to final `npm run build` so we can grab the proposed new version as seen in the demo header. Also note, the core changes are to be made in `src/index.tsx` as `./index.js` and `./index.d.ts` are _generated_
184194

185195
[MIT](./LICENSE) © 2018 [scniro](https://github.com/scniro)

0 commit comments

Comments
 (0)