Skip to content

Commit

Permalink
docs: Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Martin Makarský <martinmakarsky@gmail.com>
  • Loading branch information
ilfa and makma authored Apr 6, 2022
1 parent 2172bf4 commit 6cda818
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

## Working with code

We prefer to use [yarn](https://yarnpkg.com/) for installing dependencies and running scripts
We prefer using [yarn](https://yarnpkg.com/) for installing dependencies and running scripts.

Main branch is locked for push, so use branches to make changes and create pull request to review code and merge it in main.
The main branch is locked for the push action. For proposing changes, use the standard [pull request approach](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request). It's recommended to discuss fixes or new functionality in the Issues, first.

### Development playground

There is no specific playground for this library, but you can develop it with [fingerprintjs-pro-react](https://github.com/fingerprintjs/fingerprintjs-pro-react), just [link package](https://yarnpkg.com/cli/link) with `yarn link`.
There is no specific playground for this library, but you can develop it with [fingerprintjs-pro-react](https://github.com/fingerprintjs/fingerprintjs-pro-react), just [link package](https://yarnpkg.com/cli/link) with the `yarn link`.

❗ Build project before testing integration

Expand Down Expand Up @@ -44,7 +44,7 @@ yarn test:dts
```

### How to publish
- Create new brunch
- Run `yarn release:(major|minor|patch)` depending on version you need
- Make PR
- After merging PR in main, GitHub action will new version to npm
- Create a new branch
- Run `yarn release:(major|minor|patch)` depending on the version you need
- Make a pull request
- After merging the pull request into the main branch and after successful tests, GitHub Action will publish a new version to the npm

0 comments on commit 6cda818

Please sign in to comment.