Skip to content
This repository has been archived by the owner on Dec 9, 2020. It is now read-only.

Latest commit

 

History

History
114 lines (76 loc) · 3.2 KB

CONTRIBUTING.md

File metadata and controls

114 lines (76 loc) · 3.2 KB

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Build and run application

The following commands will go from nothing to a running application in development mode.

git clone https://github.com/FantasticFiasco/searchlight.git
cd searchlight
yarn
yarn dev

Pull Request Process

  1. Run lint and ensure that it pass
  2. Rebase and squash your commits with meaningful commit messages

Commit Messages

Format of the commit message:

<type>(<scope>): <subject>

<body>

<footer>

Message subject (first line)

The first line cannot be longer than 70 characters, the second line is always blank and other lines should be wrapped at 80 characters. The type and scope should always be lowercase as shown below.

Allowed <type> values:

  • feat - new feature for the user, not a new feature for build script
  • fix - bug fix for the user, not a fix to a build script
  • docs - changes to the documentation
  • style - formatting, missing semi colons, etc; no production code change
  • refactor - refactoring production code, eg. renaming a variable
  • test - adding missing tests, refactoring tests; no production code change
  • chore - updating grunt tasks etc; no production code change

Example <scope> values:

  • init
  • runner
  • watcher
  • config
  • web-server
  • proxy
  • etc.

The <scope> can be empty (e.g. if the change is a global or difficult to assign to a single component), in which case the parentheses are omitted.

Message body

  • uses the imperative, present tense: "change" not "changed" nor "changes"
  • includes motivation for the change and contrasts with previous behavior

For more info about message body, see:

Message footer

Referencing issues

Closed issues should be listed on a separate line in the footer prefixed with "Closes" keyword like this:

Closes #234

or in the case of multiple issues:

Closes #123
Closes #245
Closes #992

Breaking changes

All breaking changes have to be mentioned in footer with the description of the change, justification and migration notes.

BREAKING CHANGE:

`port-runner` command line option has changed to `runner-port`, so that it is
consistent with the configuration file syntax.

To migrate your project, change all the commands, where you use `--port-runner`
to `--runner-port`.

Create releases

Complete the following steps to create a new release:

  1. Draft a new GitHub release
  2. Update version in package.json and create a new chapter in CHANGELOG.md
  3. Commit with a message like release x.y.z and push to remote
  4. Wait for the build agents to upload artifacts to the GitHub release
  5. Publish the GitHub release

Credit

This document is based on AngularJS Git Commit Msg Convention.