Skip to content
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

Create contributing.md #20

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Create contributing.md #20

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Contributing

First of all, Thank you very much for taking interest on this repository. Your good intention to contribute is very appreciated.

This is a monorepo for the project masjid-network. It contains code for both Frontend and Backend. you can find the code on each respective folder.

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

### Frontend

For frontend, we use the `frontend` folder. Here is the step to contribute for the first timers:

- cd into `frontend` folder
- Type `npm install` into your terminal (make sure you have node and npm installed)
- after installing dependencies, you can start the project in development mode with `npm run dev`