-
Notifications
You must be signed in to change notification settings - Fork 301
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
28 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
# Contributing | ||
|
||
Here are the guidelines and required reading for contributing. | ||
|
||
## Getting Started | ||
|
||
### Prerequisites | ||
1. [Node.js](https://nodejs.org/en/) | ||
2. [VS Code](https://code.visualstudio.com/) (optional but recommended) | ||
|
||
### Setting up the repo | ||
1. Fork the repo and clone to your work environment | ||
2. Run `npm i` to install required dev dependencies | ||
3. Run `npm i -g [email protected]` then run `coffee -c Gruntfile.coffee` | ||
5. Run `grunt` to build the project | ||
|
||
### Running Tests | ||
|
||
After completing the 'Getting Started' section, | ||
1. Run `webdriver-manager update` to ensure the webdriver for selenium (used by protractor) is up-to-date | ||
2. Open an additional terminal and run `node e2e/express.js` to start serving the test pages | ||
3. In the original terminal, run `protractor e2e/conf.js` | ||
|
||
## Pull Request Process | ||
|
||
1. Ensure any generated files are ignored. | ||
2. Update the README.md and other documentation as it relates to your changes. | ||
3. Rebase your branch on the latest version of the branch on which it is based. This may need to happen multiple times as other PRs are merged. |