https://github.com/stencila/dev-config

🔧 Shared development configurations for Stencila projects
https://github.com/stencila/dev-config

configuration

Last synced: 3 months ago
JSON representation

🔧 Shared development configurations for Stencila projects

• Host: GitHub
• URL: https://github.com/stencila/dev-config
• Owner: stencila
• License: apache-2.0
• Created: 2019-05-31T19:33:14.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-11-03T13:19:16.000Z (3 months ago)
• Last Synced: 2024-11-12T17:47:57.649Z (3 months ago)
• Topics: configuration
• Language: JavaScript
• Homepage:
• Size: 12.4 MB
• Stars: 6
• Watchers: 4
• Forks: 0
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# `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`](./packages/dev-config)

Configurations for EditorConfig, Prettier, Husky, and more. See the [README](./packages/dev-config#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`](./packages/eslint-config)

- [`@stencila/eslint-config-stencil`](./packages/eslint-config-stencil)

- [`@stencila/semantic-release-config`](./packages/semantic-release-config)

- [`@stencila/semantic-release-config-gh-pages`](./packages/semantic-release-config-gh-pages)

## Contributing

Clone this project

```bash

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

```

Install the root project dependencies

```bash

npm install

```

Install the sub-module dependencies

```bash

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](https://github.com/conventional-changelog/conventional-changelog)

style commit messages e.g. `docs(readme): fixed spelling mistake` and

[`Lerna`](https://github.com/lerna/lerna/blob/master/commands/version/README.md#--conventional-commits).

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](https://www.conventionalcommits.org/en/v1.0.0-beta.2/) for

full details.