diff --git a/developer_docs/deployment.md b/developer_docs/deployment.md index cbf72b91..f7540bfd 100644 --- a/developer_docs/deployment.md +++ b/developer_docs/deployment.md @@ -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. -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 2. `$ npm install` diff --git a/developer_docs/installation.md b/developer_docs/installation.md index 79741123..3851abdb 100644 --- a/developer_docs/installation.md +++ b/developer_docs/installation.md @@ -4,7 +4,7 @@ Follow these instructions to set up your development environment, which you need ## 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. 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 -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. diff --git a/developer_docs/preparing_a_pull_request.md b/developer_docs/preparing_a_pull_request.md index 6711dde4..c420e437 100644 --- a/developer_docs/preparing_a_pull_request.md +++ b/developer_docs/preparing_a_pull_request.md @@ -1,6 +1,6 @@ # 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. @@ -41,14 +41,7 @@ Then ask git about the latest changes. git status ## CONFLICTS -You will probably have some conflicts! -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. +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. ## And finally, for great glory git push --set-upstream origin your-branch-name-backup