Skip to content

Commit 3c2df59

Browse files
committed
Added contributing document;
1 parent 4cd384b commit 3c2df59

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

CONTRIBUTING.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Contributing
2+
3+
Here are the guidelines and required reading for contributing.
4+
5+
## Getting Started
6+
7+
### Prerequisites
8+
1. [Node.js](https://nodejs.org/en/)
9+
2. [VS Code](https://code.visualstudio.com/) (optional but recommended)
10+
11+
### Setting up the repo
12+
1. Fork the repo and clone to your work environment
13+
2. Run `npm i` to install required dev dependencies
14+
3. Run `npm i -g [email protected]` then run `coffee -c Gruntfile.coffee`
15+
5. Run `grunt` to build the project
16+
17+
### Running Tests
18+
19+
After completing the 'Getting Started' section,
20+
1. Run `webdriver update` to ensure the webdriver for selenium (used by protractor) is up-to-date
21+
2. Open an additional terminal and run `node e2e/express.js` to start serving the test pages
22+
3. In the original terminal, run `protractor e2e/conf.js`
23+
24+
## Pull Request Process
25+
26+
1. Ensure any generated files are ignored.
27+
2. Update the README.md and other documentation as it relates to your changes.
28+
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.

0 commit comments

Comments
 (0)