Skip to content

Latest commit

 

History

History
52 lines (37 loc) · 1.24 KB

CONTRIBUTING.md

File metadata and controls

52 lines (37 loc) · 1.24 KB
Raw

Contributing Guide

This document shows you how to contribute to the project.

Dependencies

Make sure you have the following dependencies on your machine:

  • Node.js
  • npm
  • Git

Installation

Get the source by cloning the repository:

$ git clone https://github.com/fknop/angular-pipes

Navigate to the project folder and install the dependencies via:

$ npm install

Testing

The tests are run with jasmine and karma.

$ npm test

The npm test command gives you a test coverage summary in the standard output. If you wish to see a more detailed coverage report, a html report is produced in the coverage folder.

Submitting changes

  • Fork the repository
  • Checkout a new branch based on master and name it with the new feature / fix you want to do.
    • $ git checkout -b BRANCH_NAME
    • Use one branch per fix / feature
  • Make your changes
    • Make sure you have correctly exported the pipe and its module
    • Make sure to provide unit tests
    • Make sure you provided documentation for your pipe (also add links to README.md).
    • Run your tests with npm test
    • Make sure the tests pass and you have 100% coverage.
  • Commit (explicit message)
  • Push to the forked repository
  • Make a pull request