Skip to content

Commit ebe3aab

Browse files
committed
fix: update contributing docs
1 parent b6b706d commit ebe3aab

File tree

2 files changed

+16
-21
lines changed

2 files changed

+16
-21
lines changed

CONTRIBUTING.md

+11-7
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,11 @@ In return, they should reciprocate that respect in addressing your issue or asse
1111

1212
The issue tracker is the preferred channel for bug reports but please respect the following restrictions:
1313

14-
* Please **do not** use the issue tracker for personal support requests.
15-
* Please **do not** derail or troll issues. Keep the discussion on topic and respect the opinions of others.
14+
- Please **do not** use the issue tracker for personal support requests.
15+
- Please **do not** derail or troll issues. Keep the discussion on topic and respect the opinions of others.
1616

1717
<a name="bugs"></a>
18+
1819
## Bug reports
1920

2021
A bug is a _demonstrable problem_ that is caused by the code in the repository.
@@ -50,17 +51,17 @@ Example:
5051
> This might include the lines of code that you have identified as causing the bug,
5152
> and potential solutions (and your opinions on their merits).
5253
53-
5454
<a name="features"></a>
55+
5556
## Feature requests
5657

5758
Feature requests are welcome.
5859
But take a moment to find out whether your idea fits with the scope and aims of the project.
59-
It's up to *you* to make a strong case to convince the project's developers of the merits of this feature.
60+
It's up to _you_ to make a strong case to convince the project's developers of the merits of this feature.
6061
Please provide as much detail and context as possible.
6162

62-
6363
<a name="pull-requests"></a>
64+
6465
## Pull requests
6566

6667
Good pull requests - patches, improvements, new features - are a fantastic help.
@@ -123,23 +124,26 @@ Follow this process if you'd like your work considered for inclusion in the proj
123124
```
124125

125126
8. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
126-
with a clear title and description.
127+
with a clear title and description.
127128

128129
**IMPORTANT**: By submitting a patch, you agree to allow the project owner to license your work under the same license as that used by this project (MIT).
129130

130131
<a name="running-local-demo"></a>
132+
131133
## Running Local Demo
132134

133135
You can run the local demo with yarn like so:
134136

135137
```bash
136138
cd <root>
137-
yarn start
139+
yarn build
140+
yarn website:start
138141
```
139142

140143
The local app will then be available at http://localhost:3000
141144

142145
<a name="running-tests"></a>
146+
143147
## Running Tests
144148

145149
All unit tests must pass before a pull request will be approved.

website/README.md

+5-14
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,16 @@
1-
This directory contains the source for [react-split-pane.surge.sh](https://react-split-pane.now.sh).
1+
This directory contains the source for [react-split-pane.surge.sh](https://react-split-pane.surge.sh).
22
The website structure was created with [`create-react-app`](https://github.com/facebook/create-react-app), although it has since been ejected in order to add custom Webpack loaders.
33

44
## Local development
55

6-
To run this site locally, first make sure you have NPM linked `react-split-pane`:
7-
8-
```sh
9-
cd /local/path/to/react-split-pane
10-
npm link
11-
cd ./website
12-
npm link react-split-pane
13-
```
14-
15-
Then run the NPM "start" command in the project root to watch for changes to `react-split-pane`:
6+
Run the NPM "build:watch" command in the project root to watch for changes to `react-split-pane` and rebuild:
167

178
```sh
189
cd /local/path/to/react-split-pane
19-
npm run start
10+
npm run build:watch
2011
```
2112

22-
Lastly, run the NPM "start" command from this directory to run the local webserver:
13+
Lastly, run the NPM "start" command from the website directory to run the local webserver:
2314

2415
```sh
2516
cd /local/path/to/react-split-pane/website
@@ -28,7 +19,7 @@ npm run start
2819

2920
## Deployment
3021

31-
To deploy this website to Now, use the NPM "deploy" command from this directory:
22+
To deploy this website to Surge, use the NPM "deploy" command from this directory:
3223

3324
```sh
3425
cd /local/path/to/react-split-pane/website

0 commit comments

Comments
 (0)