Git Product home page Git Product logo

peakshift-website's Introduction

Prerequisites

  • node
  • npm

Getting Started

Follow the steps below to clone and set up the project.

  1. run npm install -g http-server if you don't have http-server installed already
  2. git clone [email protected]:peakshift/peakshift-website.git
  3. cd peakshift-website
  4. run npm install to download the dependencies
  5. 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

  1. Open Terminal.
  2. git pull
  3. git add file_name.py
  4. git commit -m "type(component): subject line"
  5. 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

peakshift-website's People

Contributors

johnsbeharry avatar micey969 avatar mtg2000 avatar kengeo avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.