Skip to content

Added contribution instructions to README #166

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 4, 2024
Merged

Added contribution instructions to README #166

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a981128
Added contribution steps in README
n-d-r-d-g Aug 4, 2024
918b69c
Merge branch 'main' of ndrdg-github:n-d-r-d-g/frontend.mu
n-d-r-d-g Aug 4, 2024
7479456
Updated README with suggestions
n-d-r-d-g Aug 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,19 @@ cp .env.example .env.development
```

## Feel free to contribute :D

### Run the project locally

1. Fork the repository to get your copy on your account.
2. Clone your forked repository on your machine.
3. Open the cloned `frontend.mu` directory in your code editor.
4. Run `pnpm install` in your terminal.
5. Run `pnpm run nuxt dev`.

### Submit your PR

1. Commit & push your changes on your forked repository.
2. Log in to your GitHub account & go to your forked repository's page.
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)).

**Chat with us on [Discord](https://discord.gg/WxXW9Jvv6k?ref=frontend.mu) if you're having any issue! ✌️**
Loading