docs: add doc on how to contribute to this repo (WalletConnect#241)

* docs: add doc on how to contribute to this repo * docs: run prettier * docs: update permissions for PAT * docs: update permissions for PAT * docs: remove portion about secrets * docs: update formatting --------- Co-authored-by: Paul Razvan Berg <[email protected]>
GAEAlimited · Dec 5, 2023 · cc8b52d · cc8b52d
1 parent c2670c3
commit cc8b52d
Showing 1 changed file with 27 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,27 @@
+# Contributing
+
+Feel free to dive in! [Open](https://github.com/PaulRBerg/create-eth-app/issues/new/choose) an issue,
+[start](https://github.com/PaulRBerg/create-eth-app/discussions/new/choose) a discussion or submit a PR.
+
+Contributions to `create-eth-app` are welcome by anyone interested in adding support for more frameworks or DeFi templates, writing more tests, improving readability, or improving the documentation.
+
+## Pre Requisites
+
+You will need the following software on your machine:
+
+- [Git](https://git-scm.com/downloads)
+- [Node.Js](https://nodejs.org/en/download/)
+- [Yarn](https://yarnpkg.com/)
+
+## Set Up
+
+1. Fork this repository by visiting https://github.com/PaulRBerg/create-eth-app/fork
+2. Once the fork is created, head to the forked repo. For example, [this](https://github.com/robin-thomas/create-eth-app) is a fork of the original repo.
+3. Clone the forked repo to your local machine
+4. Then, inside the project's directory, run this to install the Node.js dependencies:
+
+```bash
+$ yarn install --frozen-lockfile
+```
+
+Now you can start making changes.