Skip to content

Commit 9ea9958

Browse files
committed
chore: add contributing
1 parent 40a1996 commit 9ea9958

File tree

2 files changed

+28
-36
lines changed

2 files changed

+28
-36
lines changed

CONTRIBUTING.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
## Run the Dev Server
2+
3+
```bash
4+
# clone this repository
5+
git clone [email protected]:microlinkhq/react-json-view.git && cd react-json-view
6+
# install dependencies
7+
npm install --save-dev
8+
# run the dev server with hot reloading
9+
npm run dev
10+
```
11+
Webpack Dev Server should automatically open up http://localhost:2000 in your web browser. If it does not, open a browser and navigate to port 2000. The hot reloader will automatically reload when files are modified in the `/src/` directory.
12+
13+
## Run the Production Build
14+
15+
```bash
16+
# run the build (note: you may need to use `sudo` priveledges to run the build successfully)
17+
npm run build
18+
```
19+
Please add tests for your code before posting a pull request.
20+
21+
You can run the test suite with `npm run test` or `npm run test:watch` to automatically reload when files are modified.
22+
23+
## Docker Tools
24+
25+
I recommend using docker for development because it enforces environmental consistency.
26+
27+
For information about contributing with Docker, see the [README in ./docker](https://github.com/microlinkhq/react-json-view/blob/master/docker/README.md#contributing-to-this-project-using-docker).

README.md

+1-36
Original file line numberDiff line numberDiff line change
@@ -111,39 +111,4 @@ The following object will be passed to your method:
111111
}
112112
```
113113

114-
Returning `false` from a callback method will prevent the src from being affected.
115-
116-
### Contributing to the source code
117-
#### Run the Dev Server
118-
119-
```bash
120-
# clone this repository
121-
git clone [email protected]:microlinkhq/react-json-view.git && cd react-json-view
122-
# install dependencies
123-
npm install --save-dev
124-
# run the dev server with hot reloading
125-
npm run dev
126-
```
127-
Webpack Dev Server should automatically open up http://localhost:2000 in your web browser. If it does not, open a browser and navigate to port 2000. The hot reloader will automatically reload when files are modified in the `/src/` directory.
128-
129-
#### Run the Production Build
130-
131-
```bash
132-
# run the build (note: you may need to use `sudo` priveledges to run the build successfully)
133-
npm run build
134-
```
135-
Please add tests for your code before posting a pull request.
136-
137-
You can run the test suite with `npm run test` or `npm run test:watch` to automatically reload when files are modified.
138-
139-
#### Docker Tools
140-
141-
I recommend using docker for development because it enforces environmental consistency.
142-
143-
For information about contributing with Docker, see the [README in ./docker](https://github.com/microlinkhq/react-json-view/blob/master/docker/README.md#contributing-to-this-project-using-docker).
144-
145-
146-
### Inspiration
147-
I drew a ton of design ideas from [react-json-tree](https://github.com/alexkuz/react-json-tree). Thanks to the RJT contributors for putting together an awesome component!
148-
149-
I'm also inspired by users who come up with interesting feature requests. Reach out to me with ideas for this project or other projects you want to collaborate on. My email address is listed on my [github user page](https://github.com/mac-s-g).
114+
Returning `false` from a callback method will prevent the src from being affected.

0 commit comments

Comments
 (0)