diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..93b4c20 --- /dev/null +++ b/CONTRIBUTING.md @@ -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. + +# diff --git a/public/demo/contribute.png b/public/demo/contribute.png new file mode 100644 index 0000000..987c892 Binary files /dev/null and b/public/demo/contribute.png differ