Skip to content
This repository has been archived by the owner on Apr 17, 2018. It is now read-only.

Commit

Permalink
docs(readme): Add developer contributing documentation to README.
Browse files Browse the repository at this point in the history
  • Loading branch information
Glavin001 committed Aug 10, 2014
1 parent 217c725 commit ff12477
Showing 1 changed file with 47 additions and 0 deletions.
47 changes: 47 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,53 @@ This web-based application is being developed with three characteristics in mind
With Mozilla Advisor [Curtis Koenig](https://mozillians.org/en-US/u/curtisk/)
and Professor [Dr. Pawan Lingras](http://cs.stmarys.ca/~pawan/)

## Contributing

Please use issue branches and submit [Pull Requests](https://help.github.com/articles/using-pull-requests) for review.
Your commit messages should [AngularJS Git Commit Message Conventions](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit).

### Getting Started


#### Installing Dependencies

After cloning the repository in the location of your choice run the following commands in your Terminal:

```
npm install
bower install
```

This will install your [Node.js](http://nodejs.org/) and [Bower](http://bower.io/) dependencies.

We use [grunt-contrib-compass](https://github.com/gruntjs/grunt-contrib-compass)
which requires you to have
[Ruby](https://www.ruby-lang.org/en/downloads/),
[Sass](http://sass-lang.com/guide),
and [Compass](http://compass-style.org/install/) >=0.12.2 installed.

Please verify you have those installed (see https://github.com/gruntjs/grunt-contrib-compass#compass-task)
or you may receive the following error message when building:

```
Warning: Running "compass:dist" (compass) task
Warning: You need to have Ruby and Compass installed and in your system PATH for this task to > work. More info: https://github.com/gruntjs/grunt-contrib-compass Use --force to continue.
```

#### Building

Once you have the app dependencies installed you can start building the app.

We use [Grunt](http://gruntjs.com/). Please verify you have it installed.

Run `grunt` for building and `grunt serve` for previewing your app locally.

#### Developing

We recommend you use the [sub-generators provided](https://github.com/yeoman/generator-angular#generators)
by [generator-angular](https://github.com/yeoman/generator-angular).
Remember to follow the proper commit messages conventions: [AngularJS Git Commit Message Conventions](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit).

## Links

- [Mozilla Wiki Page](https://wiki.mozilla.org/Security/Mentorships/MWoS/2014/online_threat_modeling_tool)
Expand Down

1 comment on commit ff12477

@Glavin001
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/cc #1

Please sign in to comment.