Skip to content

Latest commit

 

History

History
82 lines (49 loc) · 2.42 KB

CONTRIBUTING.md

File metadata and controls

82 lines (49 loc) · 2.42 KB

Contribution

Table of contents

Prerequisites

  • Git :software for distributed version control
  • Node : cross-platform JavaScript runtime environment
  • Yarn : Software packaging system

Recommended

Node and Yarn can be installed with Node Version Manager nvm that allows you to quickly install and use different versions of node via the command line.

Installation

1. Clone

git clone [email protected]:anct-cartographie-nationale/timetable-to-osm-opening-hours.git

2. Install dependencies

yarn

3. Set active Husky hooks as executable

husky install
chmod a+x .husky/commit-msg
chmod a+x .husky/pre-commit

Contribution requirements

Branches naming rules

  • Must be up-to-date with master (rebased, linear history)
  • Must be prefixed with follow the build/, chore/, ci/, docs/, feat/, fix/, perf/, refactor/, revert/, style/ or test/ according to their content. See Conventional Commits cheat sheet

Commits rules

Format

Must follow conventional commits specification: Commits Conventionnels

Verified

Commits must be verified: About commit signature verification

Continuous integration check

  • All validation checks in workflow Build must pass without failure

Releases

Release on NPM and Github are fully automated on merge on master with Semantic Release.

NPM

npm npm is the world's largest javascript software registry.

Github

Repository

Forking additional setup

Github actions

  • Repository secrets to setup :
    • NODE_AUTH_TOKEN: NPM access token to publish on organisation @gouvfr-anct