Skip to content

Commit b1043aa

Browse files
Tushar SonawaneCompuIves
Tushar Sonawane
authored and
CompuIves
committed
add contributing guide (codesandbox#237)
* add contributing guide * add pull request template
1 parent fc21a9c commit b1043aa

File tree

5 files changed

+106
-26
lines changed

5 files changed

+106
-26
lines changed

‎.all-contributorsrc‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,10 @@
7878
"avatar_url": "https://avatars1.githubusercontent.com/u/1854763?v=4",
7979
"profile": "https://twitter.com/tushkiz",
8080
"contributions": [
81-
"code"
81+
"question",
82+
"code",
83+
"doc",
84+
"ideas"
8285
]
8386
},
8487
{

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
<!--
2+
Please make sure you are familiar with and follow the instructions in the
3+
contributing guidelines (found in the CONTRIBUTING.md file).
4+
5+
Please fill out the information below to expedite the review and (hopefully)
6+
merge of your pull request!
7+
-->
8+
9+
<!-- Is it a Bug fix, feature, docs update, ... -->
10+
**What kind of change does this PR introduce?**
11+
12+
<!-- You can also link to an open issue here -->
13+
**What is the current behavior?**
14+
15+
<!-- if this is a feature change -->
16+
**What is the new behavior?**
17+
18+
19+
<!-- Have you done all of these things? -->
20+
**Checklist**:
21+
<!-- add "N/A" to the end of each line that's irrelevant to your changes -->
22+
<!-- to check an item, place an "x" in the box like so: "- [x] Documentation" -->
23+
- [ ] Documentation
24+
- [ ] Tests
25+
- [ ] Ready to be merged <!-- In your opinion, is this ready to be merged as soon as it's reviewed? -->
26+
- [ ] Added myself to contributors table <!-- this is optional, see the contributing guidelines for instructions -->
27+
28+
<!-- feel free to add additional comments -->
29+
30+
<!-- Thank you for contributing! -->

‎CONTRIBUTING.md‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# Contributing to CodeSandbox Client
2+
3+
## Code Organization
4+
5+
The CodeSandbox client is currently divided in to 5 parts.
6+
7+
- `app`: The editor and profile page
8+
- `sandbox`: The preview pane of the editor
9+
- `embed`: The embedded version of CodeSandbox (which you can embed on medium)
10+
- `common`: The common parts between `sandbox`, `embed` and `app`
11+
- `homepage`: Homepage!
12+
13+
This version of CodeSandbox is using the production server as source of truth, this is specified by the environment variable `LOCAL_SERVER`. It's not yet possible to sign in using this version, I haven't figured out how to handle this yet.
14+
15+
## Setting Up the project locally
16+
17+
To install the project you need to have `yarn` and `node`
18+
19+
1. [Fork](https://help.github.com/articles/fork-a-repo/) the project, clone your fork:
20+
21+
```
22+
# Clone your fork
23+
git clone https://github.com/<your-username>/codesandbox-client.git
24+
25+
# Navigate to the newly cloned directory
26+
cd codesandbox-client
27+
```
28+
2. `yarn` to install dependencies
29+
3. `yarn start` to start the app
30+
31+
> Tip: Keep your `master` branch pointing at the original repository and make
32+
> pull requests from branches on your fork. To do this, run:
33+
>
34+
> ```
35+
> git remote add upstream https://github.com/CompuIves/codesandbox-client.git
36+
> git fetch upstream
37+
> git branch --set-upstream-to=upstream/master master
38+
> ```
39+
>
40+
> This will add the original repository as a "remote" called "upstream,"
41+
> Then fetch the git information from that remote, then set your local `master`
42+
> branch to use the upstream master branch whenever you run `git pull`.
43+
> Then you can make all of your pull request branches based on this `master`
44+
> branch. Whenever you want to update your version of `master`, do a regular
45+
> `git pull`.
46+
47+
## Submitting a Pull Request
48+
49+
Please go through existing issues and pull requests to check if somebody else is already working on it, we use `someone working on it` label to mark such issues.
50+
51+
Also, make sure to run the tests before you commit your changes.
52+
53+
```
54+
yarn test
55+
```
56+
57+
## Add yourself as a contributor
58+
59+
This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome!
60+
61+
To add yourself to the table of contributors on the `README.md`, please use the
62+
automated script as part of your PR:
63+
64+
```
65+
yarn run add-contributor
66+
```
67+
68+
Follow the prompt and commit `.all-contributorsrc` and `README.md` in the PR.
69+
70+
Thank you for taking the time to contribute! :+1:

‎README.md‎

Lines changed: 1 addition & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -12,27 +12,6 @@ The JavaScript community has sharing as its selling point. It has the biggest op
1212

1313
CodeSandbox aims to solve this by allowing developers to simply go to a URL in their browser to start building. This not only makes it easier to get started, it also makes it easier to share. You can just share your created work by sharing the URL, others can then (without downloading) further develop on these sandboxes.
1414

15-
## Organization
16-
17-
The CodeSandbox client is currently divided in to 5 parts.
18-
19-
- `app`: The editor and profile page
20-
- `sandbox`: The preview pane of the editor
21-
- `embed`: The embedded version of CodeSandbox (which you can embed on medium)
22-
- `common`: The common parts between `sandbox`, `embed` and `app`
23-
- `homepage`: Homepage!
24-
25-
This version of CodeSandbox is using the production server as source of truth, this is specified by the environment variable `LOCAL_SERVER`. It's not yet possible to sign in using this version, I haven't figured out how to handle this yet.
26-
27-
## Installation
28-
29-
To install the project you need to have `yarn` and `node`, to start:
30-
31-
```bash
32-
yarn
33-
yarn start
34-
```
35-
3615
## Other CodeSandbox repositories
3716

3817
CodeSandbox consists several separate servers, some of these are open sourced.
@@ -48,9 +27,7 @@ CodeSandbox consists several separate servers, some of these are open sourced.
4827
Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):
4928

5029
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
51-
| [<img src="https://avatars0.githubusercontent.com/u/587016?v=3" width="100px;"/><br /><sub>Ives van Hoorne</sub>](http://ivesvh.com)<br />[💬](#question-CompuIves "Answering Questions") [📝](#blog-CompuIves "Blogposts") [🐛](https://github.com/CompuIves/codesandbox-client/issues?q=author%3ACompuIves "Bug reports") [💻](https://github.com/CompuIves/codesandbox-client/commits?author=CompuIves "Code") [🎨](#design-CompuIves "Design") [📖](https://github.com/CompuIves/codesandbox-client/commits?author=CompuIves "Documentation") [💡](#example-CompuIves "Examples") [🚇](#infra-CompuIves "Infrastructure (Hosting, Build-Tools, etc)") [👀](#review-CompuIves "Reviewed Pull Requests") [⚠️](https://github.com/CompuIves/codesandbox-client/commits?author=CompuIves "Tests") [🔧](#tool-CompuIves "Tools") | [<img src="https://avatars0.githubusercontent.com/u/887639?v=3" width="100px;"/><br /><sub>Donavon West</sub>](http://donavon.com)<br />[💻](https://github.com/CompuIves/codesandbox-client/commits?author=donavon "Code") | [<img src="https://avatars0.githubusercontent.com/u/5266810?v=3" width="100px;"/><br /><sub>Jeff Allen</sub>](http://www.jeffallen.io/)<br />[💻](https://github.com/CompuIves/codesandbox-client/commits?author=vueu "Code") | [<img src="https://avatars0.githubusercontent.com/u/1089897?v=3" width="100px;"/><br /><sub>Ben Gummer</sub>](https://github.com/bengummer)<br />[💻](https://github.com/CompuIves/codesandbox-client/commits?author=bengummer "Code") | [<img src="https://avatars3.githubusercontent.com/u/154732?v=3" width="100px;"/><br /><sub>James Gillmore</sub>](http://twitter.com/faceyspacey)<br />[💻](https://github.com/CompuIves/codesandbox-client/commits?author=faceyspacey "Code") [🐛](https://github.com/CompuIves/codesandbox-client/issues?q=author%3Afaceyspacey "Bug reports") | [<img src="https://avatars1.githubusercontent.com/u/9636410?v=4" width="100px;"/><br /><sub>Ade Viankakrisna Fadlil</sub>](https://musify.id)<br />[💻](https://github.com/CompuIves/codesandbox-client/commits?author=viankakrisna "Code") | [<img src="https://avatars1.githubusercontent.com/u/1854763?v=4" width="100px;"/><br /><sub>Tushar Sonawane</sub>](https://twitter.com/tushkiz)<br />[💻](https://github.com/CompuIves/codesandbox-client/commits?author=Tushkiz "Code") |
30+
| [<img src="https://avatars0.githubusercontent.com/u/587016?v=3" width="100px;"/><br /><sub>Ives van Hoorne</sub>](http://ivesvh.com)<br />[💬](#question-CompuIves "Answering Questions") [📝](#blog-CompuIves "Blogposts") [🐛](https://github.com/CompuIves/codesandbox-client/issues?q=author%3ACompuIves "Bug reports") [💻](https://github.com/CompuIves/codesandbox-client/commits?author=CompuIves "Code") [🎨](#design-CompuIves "Design") [📖](https://github.com/CompuIves/codesandbox-client/commits?author=CompuIves "Documentation") [💡](#example-CompuIves "Examples") [🚇](#infra-CompuIves "Infrastructure (Hosting, Build-Tools, etc)") [👀](#review-CompuIves "Reviewed Pull Requests") [⚠️](https://github.com/CompuIves/codesandbox-client/commits?author=CompuIves "Tests") [🔧](#tool-CompuIves "Tools") | [<img src="https://avatars0.githubusercontent.com/u/887639?v=3" width="100px;"/><br /><sub>Donavon West</sub>](http://donavon.com)<br />[💻](https://github.com/CompuIves/codesandbox-client/commits?author=donavon "Code") | [<img src="https://avatars0.githubusercontent.com/u/5266810?v=3" width="100px;"/><br /><sub>Jeff Allen</sub>](http://www.jeffallen.io/)<br />[💻](https://github.com/CompuIves/codesandbox-client/commits?author=vueu "Code") | [<img src="https://avatars0.githubusercontent.com/u/1089897?v=3" width="100px;"/><br /><sub>Ben Gummer</sub>](https://github.com/bengummer)<br />[💻](https://github.com/CompuIves/codesandbox-client/commits?author=bengummer "Code") | [<img src="https://avatars3.githubusercontent.com/u/154732?v=3" width="100px;"/><br /><sub>James Gillmore</sub>](http://twitter.com/faceyspacey)<br />[💻](https://github.com/CompuIves/codesandbox-client/commits?author=faceyspacey "Code") [🐛](https://github.com/CompuIves/codesandbox-client/issues?q=author%3Afaceyspacey "Bug reports") | [<img src="https://avatars1.githubusercontent.com/u/9636410?v=4" width="100px;"/><br /><sub>Ade Viankakrisna Fadlil</sub>](https://musify.id)<br />[💻](https://github.com/CompuIves/codesandbox-client/commits?author=viankakrisna "Code") | [<img src="https://avatars1.githubusercontent.com/u/1854763?v=4" width="100px;"/><br /><sub>Tushar Sonawane</sub>](https://twitter.com/tushkiz)<br />[💬](#question-Tushkiz "Answering Questions") [💻](https://github.com/CompuIves/codesandbox-client/commits?author=Tushkiz "Code") [📖](https://github.com/CompuIves/codesandbox-client/commits?author=Tushkiz "Documentation") [🤔](#ideas-Tushkiz "Ideas, Planning, & Feedback") |
5231
| :---: | :---: | :---: | :---: | :---: | :---: | :---: |
5332
| [<img src="https://avatars3.githubusercontent.com/u/1239401?v=4" width="100px;"/><br /><sub>Johann Hubert Sonntagbauer</sub>](https://github.com/johann-sonntagbauer)<br />[🐛](https://github.com/CompuIves/codesandbox-client/issues?q=author%3Ajohann-sonntagbauer "Bug reports") [💻](https://github.com/CompuIves/codesandbox-client/commits?author=johann-sonntagbauer "Code") | [<img src="https://avatars2.githubusercontent.com/u/9586897?v=4" width="100px;"/><br /><sub>Joachim Seminck</sub>](https://github.com/jseminck)<br />[💻](https://github.com/CompuIves/codesandbox-client/commits?author=jseminck "Code") | [<img src="https://avatars3.githubusercontent.com/u/5210019?v=4" width="100px;"/><br /><sub>Subramanya Chakravarthy</sub>](http://chakrihacker.github.io)<br />[💻](https://github.com/CompuIves/codesandbox-client/commits?author=chakrihacker "Code") | [<img src="https://avatars3.githubusercontent.com/u/23088?v=4" width="100px;"/><br /><sub>Robert (Robby) O'Connor</sub>](http://robby.oconnor.ninja)<br />[🚇](#infra-robbyoconnor "Infrastructure (Hosting, Build-Tools, etc)") | [<img src="https://avatars0.githubusercontent.com/u/2083930?v=4" width="100px;"/><br /><sub>Bogdan Luca</sub>](https://github.com/lbogdan)<br />[🐛](https://github.com/CompuIves/codesandbox-client/issues?q=author%3Albogdan "Bug reports") [💻](https://github.com/CompuIves/codesandbox-client/commits?author=lbogdan "Code") | [<img src="https://avatars3.githubusercontent.com/u/6177621?v=4" width="100px;"/><br /><sub>Divjot Singh</sub>](http://bogas04.github.io)<br />[💻](https://github.com/CompuIves/codesandbox-client/commits?author=bogas04 "Code") | [<img src="https://avatars3.githubusercontent.com/u/5249539?v=4" width="100px;"/><br /><sub>Jason Nall</sub>](http://www.jsonnull.com)<br />[💻](https://github.com/CompuIves/codesandbox-client/commits?author=jsonnull "Code") |
5433
<!-- ALL-CONTRIBUTORS-LIST:END -->
55-
56-
This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome!

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@
172172
"lint:app": "eslint src/app",
173173
"typecheck": "flow check",
174174
"lint:embed": "eslint src/embed",
175-
"add": "all-contributors add",
175+
"add-contributor": "all-contributors add",
176176
"generate": "all-contributors generate",
177177
"precommit": "lint-staged"
178178
},

0 commit comments

Comments
 (0)