Prerequisites
Getting Started
Follow the steps below to clone and set up the project.
- run
npm install -g http-server
if you don't have http-server installed already
git clone git@github.com:peakshift/peakshift-website.git
cd peakshift-website
- run
npm install
to download the dependencies
- run
npm start
to get the development server running
Contributing
Branches
- A branch name should begin with the issue number, and have short name (2-4 words). New features or fixes should be based off of the
master
branch.
git checkout -b 123-short-name master
Pushing Changes
- Open Terminal.
git pull
git add file_name.py
git commit -m "type(component): subject line"
git push origin 123-short-name
Commit Messages
We follow the Angular commit guidelines so that we can generate changelogs and have a clean commit history — see Pushing Changes #3 for an example commit.
- Type, for your commit message commiting you should select a type from this list below:
- feat: a new features
- fix: a bug fix
- docs: documentation only changes
- style: changes that do not affect the menaing of the code (white-space, formatting, missing semi-colons, etc)
- refactor: a code change that neither fixes a bug or adds a feature
- pref: a code change that improves performance
- test: adding missing tests
- chore: changes to the build process or auxiliary tools and libraries such as documentation generation
- Components, represent the larger feature / scope of the change
- Subject line, use the imperative form of a verb
- GOOD "add contributing guidelines"
- BAD "adding contribuing guidelines"
Who do I talk to?
- Johns Beharry
- Shazelle Isaacs