Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fixes #57: Adding TO-DOs into CONTRIBUTING.md #114

Merged
merged 5 commits into from
Nov 9, 2019
Merged

Fixes #57: Adding TO-DOs into CONTRIBUTING.md #114

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
372b0e6
Fixes 57#: Adding TO-DOs into CONTRIBUTING.md
Immutablevoid Nov 9, 2019
bcf6334
Fixing title typo
Immutablevoid Nov 9, 2019
8cd6f53
Changing back to original package-lock.json
Immutablevoid Nov 9, 2019
b10c2ef
Adding one more line of instructions
Immutablevoid Nov 9, 2019
eb22cda
Another typo
Immutablevoid Nov 9, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/CONTRIBUTING.md
View file
Open in desktop
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:).
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:).

## 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