Skip to content

Commit

Permalink
Update contributing (closes UnchartedBull#1617)
Browse files Browse the repository at this point in the history
  • Loading branch information
UnchartedBull authored and pciavald committed May 12, 2021
1 parent b2c5d28 commit 3344381
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,17 @@
# General
# Contributing

If you can think of something nice to add or want to change / extend some of the functionality, feel free to create a Pull Request or an Issue. Please make sure to follow the code style (.prettierrc is included in the GitHub) and not break any of the existing functionality. Any help is greatly appreciated!
## Setting up the repository and build the package

## Prerequisites

- NodeJS v14
- npm 7

## Setup

To setup a local environment you need to do the following steps:

- Fork the repository to your GitHub account, so you can push your changes
- Clone the repository
- Install dependencies: `npm install`
Expand Down

0 comments on commit 3344381

Please sign in to comment.