/jasmine-asymmetric-tester

Sample application to showcase the Jasmine asymmetric tester

Primary LanguageJavaScriptMIT LicenseMIT

jasmine-asymmetric-tester

Sample application to showcase the Jasmine asymmetric tester

Getting Started

Initial Setup

  1. Make sure that you have the latest version of node installed (node -v); tested using v5.12.x
  2. Clone this repo git clone git@github.com:ilyakam/jasmine-asymmetric-tester.git
  3. cd jasmine-asymmetric-tester
  4. npm install

Test

  1. Run npm test

Commit Guidelines

The commit guidelines are borrowed straight from AngularJS's Contributing Guide:

Commit Message Format

Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject:

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

The header is mandatory and the scope of the header is optional.

Any line of the commit message cannot be longer 72 characters! This allows the message to be easier to read on GitHub as well as in various git tools.

Revert

If the commit reverts a previous commit, it should begin with revert: , followed by the header of the reverted commit. In the body it should say: This reverts commit <hash>., where the hash is the SHA of the commit being reverted.

Type

Must be one of the following:

  • feat: A new feature
  • fix: A bug fix
  • docs: Documentation only changes
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • refactor: A code change that neither fixes a bug nor adds a feature
  • perf: 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

Scope

The scope could be anything specifying place of the commit change.

Subject

The subject contains succinct description of the change:

  • use the imperative, present tense: "change" not "changed" nor "changes"
  • don't capitalize first letter
  • no dot (.) at the end

Body

Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior. The more verbose, the better.

Footer

The footer should contain any information about Breaking Changes and is also the place to reference GitHub issues that this commit Closes.