Skip to content

Commit be963f5

Browse files
committed
docs: Update wording and remove nwb contribution guide
1 parent 4bebbcf commit be963f5

File tree

2 files changed

+11
-17
lines changed

2 files changed

+11
-17
lines changed

CONTRIBUTING.md

+10-16
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,19 @@
1-
## Prerequisites
1+
## Contributing
22

3-
[Node.js](http://nodejs.org/) >= v4 must be installed.
3+
Contributions are **welcome** and will be fully **credited**.
44

5-
## Installation
5+
We accept contributions via Pull Requests on [Github](https://github.com/radial-color-picker/react-color-picker).
66

7-
- Running `npm install` in the component's root directory will install everything you need for development.
7+
## Pull Requests
88

9-
## Demo Development Server
9+
- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
1010

11-
- `npm start` will run a development server with the component's demo app at [http://localhost:3000](http://localhost:3000) with hot module reloading.
11+
- **Consider our release cycle** - We try to follow [SemVer](https://semver.org/). Randomly breaking public APIs is not an option.
1212

13-
## Running Tests
13+
- **Create feature branches** - Don't ask us to pull from your master branch.
1414

15-
- `npm test` will run the tests once.
15+
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
1616

17-
- `npm run test:coverage` will run the tests and produce a coverage report in `coverage/`.
17+
- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](https://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
1818

19-
- `npm run test:watch` will run the tests on every change.
20-
21-
## Building
22-
23-
- `npm run build` will build the component for publishing to npm and also bundle the demo app.
24-
25-
- `npm run clean` will delete built resources.
19+
**Happy coding**!

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ Depending on your build tool of choice (webpack, parcel, rollup) you may have to
8282
[Back To Top](#quick-links)
8383

8484
## Options
85-
`ColorPicker` is a controlled component. It's current state is defined and by the props you pass to it.
85+
`ColorPicker` is a controlled component. It's current state is defined and updated by the props you pass to it.
8686

8787
### Props
8888

0 commit comments

Comments
 (0)