Skip to content

Commit

Permalink
docs(contributing): add section on syncing fork (twilio-labs#916)
Browse files Browse the repository at this point in the history
* new pixel art

* Updating problem section

* Correction to CONTRIBUTING.md
  • Loading branch information
codeMarion authored and dkundel committed Nov 2, 2019
1 parent 77e7b0b commit 0de61fd
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,20 @@ git push origin add-my-new-pixel

Afterwards head to GitHub and [follow these instructions](https://help.github.com/en/articles/creating-a-pull-request-from-a-fork) to create a pull request from your fork against the `master` branch of github.com/twilio-labs/open-pixel-art.

### Problems When Creating a Pull Request

When many users are creating pull requests at the same time then it might be hard to get your branch up to date. The easiest way to overcome this problem is to run the following commands which brings all the required changes to your forked repo.

Make sure you have the latest changes by running this command

```bash
npm install
```
Now you can just sync it with the fork by running this command
```bash
npm run sync-fork
```

## Contributing other Changes

It's great that you want to contribute more than a pixel to this project. Before you start working on the code, make sure to check if there is already a [GitHub issue](https://github.com/twilio-labs/open-pixel-art/issues) for those changes. If there isn't, please open one first. If there is already one, make sure to create a comment to let people know that you are working on a fix for this.
Expand Down

0 comments on commit 0de61fd

Please sign in to comment.