Skip to content

Commit

Permalink
docs: documentation and contribution guidelines updated
Browse files Browse the repository at this point in the history
  • Loading branch information
arunvishnun committed Jan 5, 2023
1 parent 1fe03d5 commit a427d14
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,11 @@ There are [few guidelines](#contributing-guidelines) that we request contributor

## Getting Started

This repo uses [rushjs] for mono-repo management.
This is a mono-repo and we use [rushjs] for mono-repo management. Also, we use [pnpm] as the package manager along with [rushjs].
To read more about [rushjs with pnpm]

### Setup

This is a mono-repo and we use [rushjs] to install and local linking packages when doing development. We use rushjs with pnpm. Read more [here]


Fork and clone the repo at <https://github.com/electrode-io/electrode.git> and bootstrap all the packages.

```bash
Expand Down Expand Up @@ -121,5 +119,6 @@ The versioning of modules in the this repo are done using `rush change`. Read mo
[xclap-cli]: https://www.npmjs.com/package/xclap-cli
[docusaurus]: https://docusaurus.io/
[rushjs]: https://rushjs.io/pages/intro/welcome/
[here]: https://rushjs.io/pages/maintainer/package_managers/
[rushjs with pnpm]: https://rushjs.io/pages/maintainer/package_managers/
[best practices]: https://rushjs.io/pages/best_practices/change_logs/#recommended-practices
[pnpm]: https://pnpm.io/

0 comments on commit a427d14

Please sign in to comment.