Skip to content

Latest commit

 

History

History
48 lines (36 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

48 lines (36 loc) · 1.54 KB
Raw

How to contribute

Third-party patches are essential for keeping xtemplate great. We want to keep it as easy as possible to contribute changes that get things working in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.

Getting Started

Making Changes

  • Create a topic branch from where you want to base your work.
    • This is usually the master branch.
    • Only target release branches if you are certain your fix must be on that branch.
    • To quickly create a topic branch based on master. Please avoid working directly on the master branch.
  • Make commits of logical units and including unit tests.
  • Check for unnecessary whitespace with git diff --check before committing.
  • Make sure your commit messages are in the proper format.
  • Make sure you have added the necessary tests for your changes.
  • Run all the tests to assure nothing else was accidentally broken.

Prepare Environment

To prepare the environment for test, you can run the follow commands:

npm install bower -g
npm install
bower install
node server

Submitting Changes

  • Push your changes to a topic branch in your fork of the repository.
  • Submit a pull request.
  • Make sure travis-ci test pass.

Additional Resources