Skip to content

Commit

Permalink
update contributing md
Browse files Browse the repository at this point in the history
  • Loading branch information
LiveDuo authored Dec 19, 2021
1 parent bb3666b commit 1d21c17
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,21 @@
# Contributing to the project

- ## Instructions for development
### Instructions for development

1. `git clone https://github.com/LiveDuo/destack` and cd in there
1. Fork this repository and clone the forked repository with `git clone`

2. `npm i`
2. `cd` in the project folder and run `npm i`

3. `npm run dev` and head to `localhost:3000`
3. `npm run dev` and head to `localhost:3000` (for React.js use `npm run dev:react`)

4. Make changes in lib/destack and create a PR 🚀

Note: Requires NPM version 7 or later (which supports NPM workspaces). To update NPM to the latest version run the following, `sudo npm install -g npm`.

### Instructions for deploying

- Alpha: `npm run publish:alpha`

- Beta: `npm run publish:beta`

- Stable: `npm publish`

0 comments on commit 1d21c17

Please sign in to comment.