README.md

dev-config

🔧 Shared development configurations for Stencila projects

This repository contains configuration settings for various development tools used across Stencila projects. This allows to avoid boilerplate when creating projects, have consistent settings across projects, and simplify workflows in general.

@stencila/dev-config

Configurations for EditorConfig, Prettier, Husky, and more. See the README for details. This package is dependent on two other packages (that need to be separate NPM packages for the particular tool's shared configuration mechanism to work):

• @stencila/eslint-config
• @stencila/eslint-config-stencil
• @stencila/semantic-release-config
• @stencila/semantic-release-config-gh-pages

Contributing

Clone this project

git clone [email protected]:stencila/dev-config.git

Install the root project dependencies

npm install

Install the sub-module dependencies

npx lerna bootstrap

Releasing new versions

Release are generated automatically when Pull Requests are merged into the master branch.

This process is automated thanks to conventional changelog style commit messages e.g. docs(readme): fixed spelling mistake and Lerna. They enable us to automate version management: minor version releases are done if any feat(...) commits are pushed, patch version releases are done if any fix(...) commits are pushed. See the specifications for full details.