-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(contributing): update instructions
- Loading branch information
1 parent
3428a71
commit 6bcf668
Showing
2 changed files
with
13 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters