Skip to content

Commit

Permalink
docs(contributing): update instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
ivangabriele committed Feb 7, 2024
1 parent 3428a71 commit 6bcf668
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 29 deletions.
36 changes: 10 additions & 26 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,18 @@
# Contributing

### Getting Started
- [Getting Started](#getting-started)
- [Release](#release)

```sh
npm i
```

### Release
## Getting Started

```sh
npm version X.Y.Z
yarn
yarn prepare
```

This will automatically create a full tagged commit with packages version bump in a version branch before pushing them
to the remote repository.
## Release

### Recommended IDE Settings

```json
{
"editor.codeActionsOnSave": {
"source.fixAll": true
},
"eslint.codeActionsOnSave.mode": "all",
"editor.defaultFormatter": "dbaeumer.vscode-eslint",
"eslint.format.enable": true,
"editor.formatOnSave": true,
"eslint.packageManager": "npm",
"[json]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
}
}
```
1. Got to the [Release workflow](https://github.com/ivangabriele/eslint-config/actions/workflows/release.yml)
2. Click on "Run workflow"
3. Select "Branch: main" if it's not already selected
4. Click on "Run workflow"
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -356,18 +356,18 @@ yarn dlx @yarnpkg/sdks vscode

## Contribute

Please check the [contributing documentation](CONTRIBUTING.md).
Please refer to the [contribution guidelines](./CONTRIBUTING.md) for information on how to contribute to this project.

---

[img-github]: https://img.shields.io/github/actions/workflow/status/ivangabriele/eslint-config/check.yml?branch=main&style=for-the-badge
[img-github]:
https://img.shields.io/github/actions/workflow/status/ivangabriele/eslint-config/check.yml?branch=main&style=for-the-badge
[img-license]: https://img.shields.io/github/license/ivangabriele/eslint-config?style=for-the-badge
[img-npm-base]: https://img.shields.io/npm/v/@ivangabriele/eslint-config-base?style=flat-square
[img-npm-react]: https://img.shields.io/npm/v/@ivangabriele/eslint-config-react?style=flat-square
[img-npm-typescript-base]: https://img.shields.io/npm/v/@ivangabriele/eslint-config-typescript-base?style=flat-square
[img-npm-typescript-next]: https://img.shields.io/npm/v/@ivangabriele/eslint-config-typescript-next?style=flat-square
[img-npm-typescript-react]: https://img.shields.io/npm/v/@ivangabriele/eslint-config-typescript-react?style=flat-square

[lnk-github]: https://github.com/ivangabriele/eslint-config/actions?query=branch%3Amain++
[lnk-license]: https://github.com/ivangabriele/eslint-config/blob/main/LICENSE
[lnk-npm-base]: https://www.npmjs.com/package/@ivangabriele/eslint-config-base
Expand Down

0 comments on commit 6bcf668

Please sign in to comment.