Skip to content

Commit 1dbfce7

Browse files
authored
Merge pull request #166 from n-d-r-d-g/main
Added contribution instructions to README
2 parents 783d042 + 7479456 commit 1dbfce7

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,19 @@ cp .env.example .env.development
3131
```
3232

3333
## Feel free to contribute :D
34+
35+
### Run the project locally
36+
37+
1. Fork the repository to get your copy on your account.
38+
2. Clone your forked repository on your machine.
39+
3. Open the cloned `frontend.mu` directory in your code editor.
40+
4. Run `pnpm install` in your terminal.
41+
5. Run `pnpm run nuxt dev`.
42+
43+
### Submit your PR
44+
45+
1. Commit & push your changes on your forked repository.
46+
2. Log in to your GitHub account & go to your forked repository's page.
47+
3. On the `Code` tab, click `Contribute` and then `Open a pull request` to submit your PR ([read more about this](https://docs.github.com/en/get-started/exploring-projects-on-github/contributing-to-a-project#making-a-pull-request)).
48+
49+
**Chat with us on [Discord](https://discord.gg/WxXW9Jvv6k?ref=frontend.mu) if you're having any issue! ✌️**

0 commit comments

Comments
 (0)