Skip to content

Commit

Permalink
chore: update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
wolimst committed May 13, 2024
1 parent f65a58b commit d032149
Showing 1 changed file with 13 additions and 9 deletions.
22 changes: 13 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,26 @@

Welcome and thank you for investing your time in contributing to Handle!

## Issues

If you find any problems or have ideas to improve Handle, please open an issue in the repository!

## Developing

### Requirements and Setup

Handle requires [Node.js][nodejs] v14 or newer, and some dependencies.
Handle requires [Node.js][nodejs] v20 (LTS) or newer, and some dependencies.
After installing Node.js, you can install dependencies as below, and you should be ready to develop Handle!

```shell
git clone git@github.com:wolimst/handle.git
cd handle
npm install
npm ci
```

### Useful Commands

- Clean and install dependencies
- Clean install dependencies

```shell
npm ci
Expand Down Expand Up @@ -51,12 +55,12 @@ Refer to `scripts` section in `package.json` file for more commands.

## [Pull Request Process][docs-pull-requests]

1. Fork this repository and create your branch from `main`
1. Make changes and add tests if necessary
1. Make sure to run checks, tests and formatter
1. Submit a pull request with comprehensive description about the changes you've made
1. Please respond back to questions or change requests, if there is any, from a reviewer
1. The reviewer will approve and merge the pull request!
1. Fork this repository and create your branch from `main`.
1. Make changes and add tests if necessary.
1. Make sure to run checks, tests and formatter.
1. Submit a pull request with comprehensive description about the changes you've made.
1. Please respond back to questions or change requests, if there is any, from a reviewer.
1. If everything is ok, the reviewer will approve and merge the pull request!

[nodejs]: https://nodejs.org/
[docs-pull-requests]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/getting-started/about-collaborative-development-models

0 comments on commit d032149

Please sign in to comment.