From 107b4d46d6b579b8f01f676cebc82a34546d5c80 Mon Sep 17 00:00:00 2001 From: Tushar Sonawane Date: Thu, 12 Oct 2017 19:15:50 +0530 Subject: [PATCH 1/2] add contributing guide --- .all-contributorsrc | 5 +++- CONTRIBUTING.md | 70 +++++++++++++++++++++++++++++++++++++++++++++ README.md | 25 +--------------- package.json | 2 +- 4 files changed, 76 insertions(+), 26 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/.all-contributorsrc b/.all-contributorsrc index e6a4e058d71..232bdd531ef 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -78,7 +78,10 @@ "avatar_url": "https://avatars1.githubusercontent.com/u/1854763?v=4", "profile": "https://twitter.com/tushkiz", "contributions": [ - "code" + "question", + "code", + "doc", + "ideas" ] }, { diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000000..6947ee949c6 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,70 @@ +# Contributing to CodeSandbox Client + +## Code Organization + +The CodeSandbox client is currently divided in to 5 parts. + +- `app`: The editor and profile page +- `sandbox`: The preview pane of the editor +- `embed`: The embedded version of CodeSandbox (which you can embed on medium) +- `common`: The common parts between `sandbox`, `embed` and `app` +- `homepage`: Homepage! + +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. + +## Setting Up the project locally + +To install the project you need to have `yarn` and `node` + +1. [Fork](https://help.github.com/articles/fork-a-repo/) the project, clone your fork: + + ``` + # Clone your fork + git clone https://github.com//codesandbox-client.git + + # Navigate to the newly cloned directory + cd codesandbox-client + ``` +2. `yarn` to install dependencies +3. `yarn start` to start the app + +> Tip: Keep your `master` branch pointing at the original repository and make +> pull requests from branches on your fork. To do this, run: +> +> ``` +> git remote add upstream https://github.com/CompuIves/codesandbox-client.git +> git fetch upstream +> git branch --set-upstream-to=upstream/master master +> ``` +> +> This will add the original repository as a "remote" called "upstream," +> Then fetch the git information from that remote, then set your local `master` +> branch to use the upstream master branch whenever you run `git pull`. +> Then you can make all of your pull request branches based on this `master` +> branch. Whenever you want to update your version of `master`, do a regular +> `git pull`. + +## Submitting a Pull Request + +Please go through existing pull requests and check if somebody else is already working on this. + +Also, make sure to run the tests before you commit your changes. + +``` +yarn test +``` + +## Add yourself as a contributor + +This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome! + +To add yourself to the table of contributors on the `README.md`, please use the +automated script as part of your PR: + +``` +yarn run add-contributor +``` + +Follow the prompt and commit `.all-contributorsrc` and `README.md` in the PR. + +Thank you for taking the time to contribute! :+1: diff --git a/README.md b/README.md index 2cf0a1c4efd..8147b5046b1 100644 --- a/README.md +++ b/README.md @@ -12,27 +12,6 @@ The JavaScript community has sharing as its selling point. It has the biggest op 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. -## Organization - -The CodeSandbox client is currently divided in to 5 parts. - -- `app`: The editor and profile page -- `sandbox`: The preview pane of the editor -- `embed`: The embedded version of CodeSandbox (which you can embed on medium) -- `common`: The common parts between `sandbox`, `embed` and `app` -- `homepage`: Homepage! - -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. - -## Installation - -To install the project you need to have `yarn` and `node`, to start: - -```bash -yarn -yarn start -``` - ## Other CodeSandbox repositories 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. Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)): -| [
Ives van Hoorne](http://ivesvh.com)
[💬](#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") | [
Donavon West](http://donavon.com)
[💻](https://github.com/CompuIves/codesandbox-client/commits?author=donavon "Code") | [
Jeff Allen](http://www.jeffallen.io/)
[💻](https://github.com/CompuIves/codesandbox-client/commits?author=vueu "Code") | [
Ben Gummer](https://github.com/bengummer)
[💻](https://github.com/CompuIves/codesandbox-client/commits?author=bengummer "Code") | [
James Gillmore](http://twitter.com/faceyspacey)
[💻](https://github.com/CompuIves/codesandbox-client/commits?author=faceyspacey "Code") [🐛](https://github.com/CompuIves/codesandbox-client/issues?q=author%3Afaceyspacey "Bug reports") | [
Ade Viankakrisna Fadlil](https://musify.id)
[💻](https://github.com/CompuIves/codesandbox-client/commits?author=viankakrisna "Code") | [
Tushar Sonawane](https://twitter.com/tushkiz)
[💻](https://github.com/CompuIves/codesandbox-client/commits?author=Tushkiz "Code") | +| [
Ives van Hoorne](http://ivesvh.com)
[💬](#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") | [
Donavon West](http://donavon.com)
[💻](https://github.com/CompuIves/codesandbox-client/commits?author=donavon "Code") | [
Jeff Allen](http://www.jeffallen.io/)
[💻](https://github.com/CompuIves/codesandbox-client/commits?author=vueu "Code") | [
Ben Gummer](https://github.com/bengummer)
[💻](https://github.com/CompuIves/codesandbox-client/commits?author=bengummer "Code") | [
James Gillmore](http://twitter.com/faceyspacey)
[💻](https://github.com/CompuIves/codesandbox-client/commits?author=faceyspacey "Code") [🐛](https://github.com/CompuIves/codesandbox-client/issues?q=author%3Afaceyspacey "Bug reports") | [
Ade Viankakrisna Fadlil](https://musify.id)
[💻](https://github.com/CompuIves/codesandbox-client/commits?author=viankakrisna "Code") | [
Tushar Sonawane](https://twitter.com/tushkiz)
[💬](#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") | | :---: | :---: | :---: | :---: | :---: | :---: | :---: | | [
Johann Hubert Sonntagbauer](https://github.com/johann-sonntagbauer)
[🐛](https://github.com/CompuIves/codesandbox-client/issues?q=author%3Ajohann-sonntagbauer "Bug reports") [💻](https://github.com/CompuIves/codesandbox-client/commits?author=johann-sonntagbauer "Code") | [
Joachim Seminck](https://github.com/jseminck)
[💻](https://github.com/CompuIves/codesandbox-client/commits?author=jseminck "Code") | [
Subramanya Chakravarthy](http://chakrihacker.github.io)
[💻](https://github.com/CompuIves/codesandbox-client/commits?author=chakrihacker "Code") | [
Robert (Robby) O'Connor](http://robby.oconnor.ninja)
[🚇](#infra-robbyoconnor "Infrastructure (Hosting, Build-Tools, etc)") | [
Bogdan Luca](https://github.com/lbogdan)
[🐛](https://github.com/CompuIves/codesandbox-client/issues?q=author%3Albogdan "Bug reports") [💻](https://github.com/CompuIves/codesandbox-client/commits?author=lbogdan "Code") | [
Divjot Singh](http://bogas04.github.io)
[💻](https://github.com/CompuIves/codesandbox-client/commits?author=bogas04 "Code") | [
Jason Nall](http://www.jsonnull.com)
[💻](https://github.com/CompuIves/codesandbox-client/commits?author=jsonnull "Code") | - -This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome! diff --git a/package.json b/package.json index dc224bbb562..b8f77ee1842 100644 --- a/package.json +++ b/package.json @@ -172,7 +172,7 @@ "lint:app": "eslint src/app", "typecheck": "flow check", "lint:embed": "eslint src/embed", - "add": "all-contributors add", + "add-contributor": "all-contributors add", "generate": "all-contributors generate", "precommit": "lint-staged" }, From 8c29d5d8f3527e4154498d912711c2bfba66c2e9 Mon Sep 17 00:00:00 2001 From: Tushar Sonawane Date: Thu, 12 Oct 2017 23:58:15 +0530 Subject: [PATCH 2/2] add pull request template --- .github/PULL_REQUEST_TEMPLATE.md | 30 ++++++++++++++++++++++++++++++ CONTRIBUTING.md | 2 +- 2 files changed, 31 insertions(+), 1 deletion(-) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000000..72e6eb35e02 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,30 @@ + + + +**What kind of change does this PR introduce?** + + +**What is the current behavior?** + + +**What is the new behavior?** + + + +**Checklist**: + + +- [ ] Documentation +- [ ] Tests +- [ ] Ready to be merged +- [ ] Added myself to contributors table + + + + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6947ee949c6..4080f058756 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -46,7 +46,7 @@ To install the project you need to have `yarn` and `node` ## Submitting a Pull Request -Please go through existing pull requests and check if somebody else is already working on this. +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. Also, make sure to run the tests before you commit your changes.