Skip to content

Latest commit

 

History

History
33 lines (19 loc) · 1.2 KB

contributing.md

File metadata and controls

33 lines (19 loc) · 1.2 KB
Raw

How to Contribute

Thanks for taking the time to contribute!

Submitting Changes

We use commitizen to enforce conventional commits. This enables us to automate both semantic versioning and npm releases.

Install the commitizen command line tool:

npm install -g commitizen

Now simply use git cz or just cz instead of git commit when committing.

If you prefer not to install the commitizen command globally, alternatively you can use npm run commit instead of git commit.

Coding Conventions

  • Prettier is ran and applied automatically as part of a precommit hook, so you don't have to worry about semicolons or trailing commas

Inspirations

This package follows the lead of the Open-Source API biketag, with it's configurations for compiling, testing, and contributing to Javascript APIs written in TypeScript. Also, the BikeTag API utilizes the node-imgur package to do it's thing, with admiration.