Skip to content

Commit

Permalink
Merge pull request #114 from ImmutableBox/issue57
Browse files Browse the repository at this point in the history
Fixes 57#: Adding TO-DOs into CONTRIBUTING.md
  • Loading branch information
Immutablevoid authored Nov 9, 2019
2 parents a7fc543 + eb22cda commit 5799a6f
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,15 @@ An easier solution would be to use Docker.
1. Copy env.example to .env to create a new environment configuration.
1. Replace default key values in .env with credentials.
1. Run `npm install`.
1. Run `npm test`
1. IF eslint detect some issues run `npm run eslint-fix` before manually fixing the issue (Will save you time :smile:) and then run `npm test` again.
1. Run `npm start` to start telescope.
*If you get a series of errors, you may have to start redis-server depending on your installation configuration, do this by running the command `redis-server` in a seperate command window).*

**THE LIST OF THINGS THAT MUST BE DONE BY A CONTRIBUTOR BEFORE FILLING A PR**
1. Run `npm test`
1. IF eslint detect some issues run `npm run eslint-fix` before manually fixing the issue (Will save you time :smile:) and then run `npm test` again.

## MVP Features
These features are the basic elements of what we are trying to accomplish, and are explained in further detail in [overview.md](https://github.com/Seneca-CDOT/telescope/blob/master/docs/overview.md#mvp-features):

Expand Down

0 comments on commit 5799a6f

Please sign in to comment.