diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..442ebca --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,89 @@ +# Contributing Guidelines + +We are happy to welcome all the contributions **no contribution is too small.** + + +- Before opening a new issue, please **check** if it is already created or not. +- Pull requests will be merged after being **reviewed by a madhav**. +- Create a pull request from a **branch** other than `main`. +- It might take a day to review your pull request. Please have patience and be nice. +- We all are here to learn. You are allowed to make mistakes. That's how you learn, right! + +- Pull Requests review criteria: + - Please fill the **PR template** properly while making a PR + - You must add your code file into the respective **folders**. + - Your work must be **original**, written by you not copied from other resources. + - You must **comment** on your code where necessary. + - For **frontend changes** kindly share screenshots and work samples of your work before sending a PR. + + +# Submitting Contributions๐Ÿ‘ฉโ€๐Ÿ’ป๐Ÿ‘จโ€๐Ÿ’ป +Below you will find the process and workflow used to review and merge your changes. + +## Step 0 : Find an issue ๐Ÿ” +- Take a look at the Existing Issues or create your **own** Issues! +- Wait for the Issue to be assigned to you after which you can start working on it. +- Note : Every change in this project should/must have an associated issue. +![issue](https://github.com/TheLeanProgrammer/TheLeanProgrammer.github.io/issues) + +## Step 1 : Fork the Project ๐Ÿด +- Fork this Repository. This will create a Local Copy of this Repository on your Github Profile. Keep a reference to the original project in `upstream` remote. +``` +$ git clone https://github.com//Community-Website +$ cd +$ git remote add upstream https://github.com/TheLeanProgrammer/TheLeanProgrammer +``` +![fork](git@github.com:TheLeanProgrammer/TheLeanProgrammer.github.io.git) + +- Update your forked repo before working. +``` +$ git remote update +$ git checkout +$ git rebase upstream/ +``` +## Step 2 : Branch ๐Ÿ”– +Create a new branch. Use its name to identify the issue you are addressing. +``` +# It will create a new branch with name Branch_Name and switch to that branch +$ git checkout -b branch_name +``` + +## Step 3 : Commit +- To commit give a descriptive message for the convenience of reviewer by: +``` +# This message get associated with all files you have changed +$ git commit -m "message" +``` + +### Commit message guidelines +- Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject: +``` +(): + + + +