From a73e4e28aad90a34a94ef74c7f1a0e4fa57a339b Mon Sep 17 00:00:00 2001 From: davidbonan Date: Thu, 9 Jan 2020 12:06:24 +0100 Subject: [PATCH] Add contributing md (#279) * Add contributing setup file * Add sandbox method --- CONTRIBUTING.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..89cf662c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,29 @@ +# Contributing + + +## Setup + +### Option 1 - Manual + +1. Fork and clone the repo +1. Run `npm install` to install dependencies +1. Create a branch for your PR with `git checkout -b your-branch-name` + +> To keep `master` branch pointing to remote repository and make +> pull requests from branches on your fork. To do this, run: +> +> ```sh +> git remote add upstream https://github.com/excalidraw/excalidraw.git +> git fetch upstream +> git branch --set-upstream-to=upstream/master master +> ``` +> + +### Option 2 - Codesandbox + +1. Go to https://codesandbox.io/s/github/excalidraw/excalidraw +1. Connect your Github account +1. Go to Git tab on left side +1. Tap on `Fork Sandbox` +1. Write your code +1. Commit and PR automatically