Skip to content

Commit

Permalink
add: Contribution guide
Browse files Browse the repository at this point in the history
  • Loading branch information
alfaarghya committed Jan 29, 2024
1 parent 3df18d1 commit bbc6938
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
### Wanna Contribute 🤔??

- #### 🍴 Create a Fork of this repo to your GitHub Account

![Alt text](./public/demo/contribute.png)

- #### 🧑🏽‍💻 Clone the Your Repo Locally

first open your CLI and clone the repo locally. But don't forget put your github username in **username**

```bash
git clone https://github.com/username/alfa-leetcode-api.git
```

- #### 👋🏽 Go to the project folder

```bash
cd alfa-leetcode-api
```

- #### 🚀 Install Require modules

```bash
npm install
```

- #### 🏃🏽‍♂️Run Project Locally

```bash
npm start
```

- #### 💡 Make Changes & Pull Requests

Make changes as require and push it to your GitHub with proper **commit message**. From their Create a **PR(Pull Request)** and submit it.

- #### 📌 Additional Tip

Try to make a new branch relevant to your work. For example - `fix:xyz-issue`

📝Note - It's not Necessary for contribution but it will help me to marge it.

#
Binary file added public/demo/contribute.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit bbc6938

Please sign in to comment.