Skip to content

Latest commit

 

History

History
142 lines (101 loc) · 4.79 KB

CONTRIBUTING.md

File metadata and controls

142 lines (101 loc) · 4.79 KB
Raw

Hi (future) collaborator!

tl;dr;

Table of Contents

Where to start?

Have a fix or a new feature? Search for corresponding issues first then create a new one.

Development workflow

We use the places website as a way to develop the places.js library.

Requirements:

  • Node.js, prefer latest stable.
  • Ruby, prefer latest stable.
  • Bundler, prefer latest stable.
npm run dev

Open http://localhost.localdomain:4567/.

Any change made to places.js library or the docs will trigger an autoreload.

Testing

We have a unit test suite written with Jest.

npm test
npm run test:watch

You can use all of the Jest API and the Jasmine API.

Commit message guidelines

We use conventional changelog to generate our changelog from our git commit messages.

Here are the rules to write commit messages, they are the same than angular/angular.js.

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 100 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. For example RefinementList, refinementList, rangeSlider, CI, url, build etc...

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.

Footer

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

Breaking Changes should start with the word BREAKING CHANGE: with a space or two newlines. The rest of the commit message is then used for this.

Squash your commits

Once you are done with a fix or feature and the review was done, squash your commits to avoid things like "fix dangling comma in bro.js", "fix after review".

The goal is to have meaningful, feature based commits instead of a lot of small commits.

Example: - feat(widget): new feature blabla.. - refactor new feature blablabla... - fix after review ...

  • both commits should be squashed in a single commit: feat(widget) ..

Releasing

If you are a maintainer, you can release.

We use semver.

You must be on the master branch.

npm run release