r/p5.js-web-editor
1
0
Fork 0
Code Issues 1 Pull requests Releases 1 Wiki Activity

finish updates to developer docs, fixes #995

Browse source
This commit is contained in:
Cassie Tarakajian 2019-03-28 16:34:24 -04:00
parent 98ac3bafcc
commit 15b38a0bc8
3 changed files with 5 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
developer_docs/deployment.md
View file

@ -29,7 +29,7 @@ These are the steps that happen when you deploy the application.
You'll only need to do this if you're testing the production environment locally. You'll only need to do this if you're testing the production environment locally.
Note: The installation steps assume you are using a Unix-like shell. If you are using Windows, you will need to use `copy` instead of `cp`. _Note_: The installation steps assume you are using a Unix-like shell. If you are using Windows, you will need to use `copy` instead of `cp`.
1. Clone this repository and `cd` into it 1. Clone this repository and `cd` into it
2. `$ npm install` 2. `$ npm install`

4
developer_docs/installation.md
View file

@ -4,7 +4,7 @@ Follow these instructions to set up your development environment, which you need
## Manual Installation ## Manual Installation
Note: The installation steps assume you are using a Unix-like shell. If you are using Windows, you will need to use `copy` instead of `cp`. _Note_: The installation steps assume you are using a Unix-like shell. If you are using Windows, you will need to use `copy` instead of `cp`.
1. Install [node.js](http://nodejs.org/), which also automatically installs the [npm](https://www.npmjs.org) package manager. 1. Install [node.js](http://nodejs.org/), which also automatically installs the [npm](https://www.npmjs.org) package manager.
2. [Fork](https://help.github.com/articles/fork-a-repo) the [p5.js Web Editor repository](https://github.com/processing/p5.js-web-editor) into your own GitHub account. 2. [Fork](https://help.github.com/articles/fork-a-repo) the [p5.js Web Editor repository](https://github.com/processing/p5.js-web-editor) into your own GitHub account.
@ -33,7 +33,7 @@ Note: The installation steps assume you are using a Unix-like shell. If you are
## Docker Installation ## Docker Installation
Note: The installation steps assume you are using a Unix-like shell. If you are using Windows, you will need to use `copy` instead of `cp`. _Note_: The installation steps assume you are using a Unix-like shell. If you are using Windows, you will need to use `copy` instead of `cp`.
Using Docker, you can have a complete, consistent development environment without having to manually install dependencies such as Node, Mongo, etc. It also helps isolate these dependencies and their data from other projects that you may have on the same computer that use different/conflicting versions, etc. Using Docker, you can have a complete, consistent development environment without having to manually install dependencies such as Node, Mongo, etc. It also helps isolate these dependencies and their data from other projects that you may have on the same computer that use different/conflicting versions, etc.

11
developer_docs/preparing_a_pull_request.md
View file

@ -1,6 +1,6 @@
# Preparing a pull request # Preparing a pull request
Copied from the [p5.js repository](https://github.com/processing/p5.js). Copied and updated from the [p5.js repository](https://github.com/processing/p5.js).
Pull-requests are easier when your code is up to date! You can use git rebase to update your code to incorporate changes from other contributors. Here's how. Pull-requests are easier when your code is up to date! You can use git rebase to update your code to incorporate changes from other contributors. Here's how.
@ -41,14 +41,7 @@ Then ask git about the latest changes.
git status git status
## CONFLICTS ## CONFLICTS
You will probably have some conflicts! You may have some conflicts! It's okay. Feel free to ask for help. If merging with the latest upstream master causes conflicts, you can always make a pull request with the upstream repository, which makes the merge conflicts public.
If it’s just lib/p5.js and lib/p5.min.js, it’s easy to fix. just build the project again with grunt.
grunt
git add -u
git rebase --continue
If you have conflicts in other files & you're not sure how to resolve them... ask for help! Lauren, David, Kevin, and Kate are familiar with recent changes and can help you figure out what's new.
## And finally, for great glory ## And finally, for great glory
git push --set-upstream origin your-branch-name-backup git push --set-upstream origin your-branch-name-backup