Skip to content

Latest commit

 

History

History
52 lines (29 loc) · 1.78 KB

README.md

File metadata and controls

52 lines (29 loc) · 1.78 KB
Raw

Oops

Contributing

The best way to achieve this is together! That's why we are on GitHub. We would love contributions from the community (bug reports, feature requests, suggestions, Pull Requests, whatever you want!).

Yarn is used as package manager. Semantic Release is used to manage the whole package release workflow.

To setup your local dev environment:

  1. Install Yarn

  2. Clone repository

git clone git@github.com:ctrlup-io/oops.git
cd oops
  1. Install dependencies
yarn install
  1. See more available scripts

Available Scripts

In the project directory, you can run:

commit

Runs the git-cz CLI to generate commit messages according to the Conventional Commit specifications.

lint

Runs ESLint with standard configuration.

We recommend to use ESLint in your IDE, e.g. in Visual Studio code with ESLint.

format

Runs Prettier with basic configuration.

We recommend to use Prettier in your IDE, e.g. in Visual Studio code with Prettier - Code formatter.

release:dry

Runs Semantic Release in dry-run mode. It allows you to preview the pending release.

You have to set NPM_TOKEN and GITHUB_TOKEN in .env file.