You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+11-7
Original file line number
Diff line number
Diff line change
@@ -11,10 +11,11 @@ In return, they should reciprocate that respect in addressing your issue or asse
11
11
12
12
The issue tracker is the preferred channel for bug reports but please respect the following restrictions:
13
13
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.
16
16
17
17
<aname="bugs"></a>
18
+
18
19
## Bug reports
19
20
20
21
A bug is a _demonstrable problem_ that is caused by the code in the repository.
@@ -50,17 +51,17 @@ Example:
50
51
> This might include the lines of code that you have identified as causing the bug,
51
52
> and potential solutions (and your opinions on their merits).
52
53
53
-
54
54
<aname="features"></a>
55
+
55
56
## Feature requests
56
57
57
58
Feature requests are welcome.
58
59
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.
60
61
Please provide as much detail and context as possible.
61
62
62
-
63
63
<aname="pull-requests"></a>
64
+
64
65
## Pull requests
65
66
66
67
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
123
124
```
124
125
125
126
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.
127
128
128
129
**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).
129
130
130
131
<aname="running-local-demo"></a>
132
+
131
133
## Running Local Demo
132
134
133
135
You can run the local demo with yarn like so:
134
136
135
137
```bash
136
138
cd<root>
137
-
yarn start
139
+
yarn build
140
+
yarn website:start
138
141
```
139
142
140
143
The local app will then be available at http://localhost:3000
141
144
142
145
<aname="running-tests"></a>
146
+
143
147
## Running Tests
144
148
145
149
All unit tests must pass before a pull request will be approved.
Copy file name to clipboardExpand all lines: website/README.md
+5-14
Original file line number
Diff line number
Diff 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).
2
2
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.
3
3
4
4
## Local development
5
5
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:
16
7
17
8
```sh
18
9
cd /local/path/to/react-split-pane
19
-
npm run start
10
+
npm run build:watch
20
11
```
21
12
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:
23
14
24
15
```sh
25
16
cd /local/path/to/react-split-pane/website
@@ -28,7 +19,7 @@ npm run start
28
19
29
20
## Deployment
30
21
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:
0 commit comments