-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
07b8795
commit 07ad309
Showing
1 changed file
with
80 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,80 @@ | ||
# How to contribute | ||
|
||
Thanks for taking the time to contribute! Please follow the instructions below | ||
|
||
------------------------------------------------------------------------------ | ||
|
||
**1.** Fork [this](https://github.com/vj-abigo/invite-on-label.git) repository. | ||
|
||
![step1](https://user-images.githubusercontent.com/72425181/122670266-be43ee80-d1de-11eb-9330-8d07ce2bd7ab.png) | ||
|
||
|
||
**2.** Clone your forked copy of the project. | ||
|
||
``` | ||
git clone https://github.com/<your_user_name>/invite-on-label.git | ||
``` | ||
|
||
**3.** Navigate to the project directory :file_folder: . | ||
|
||
``` | ||
cd invite-on-label | ||
``` | ||
|
||
**4.** Add a reference(remote) to the original repository. | ||
|
||
``` | ||
git remote add upstream https://github.com/vj-abigo/invite-on-label.git | ||
``` | ||
|
||
**5.** Check the remotes for this repository. | ||
|
||
``` | ||
git remote -v | ||
``` | ||
|
||
**6.** Always take a pull from the upstream repository to your master branch to keep it at par with the main project(updated repository). | ||
|
||
``` | ||
git pull upstream main | ||
``` | ||
|
||
**7.** Create a new branch. | ||
|
||
``` | ||
git checkout -b <your_branch_name> | ||
``` | ||
|
||
**8.** Perform your desired changes to the code base. | ||
|
||
<p align="center"><img width=35% src="https://media2.giphy.com/media/L1R1tvI9svkIWwpVYr/giphy.gif?cid=ecf05e47pzi2rpig0vc8pjusra8hiai1b91zgiywvbubu9vu&rid=giphy.gif"></p> | ||
|
||
**9.** add your changes:heavy_check_mark: . | ||
|
||
``` | ||
git add . | ||
``` | ||
|
||
**10.** Commit your changes . | ||
|
||
``` | ||
git commit -m "Relevant message" | ||
``` | ||
|
||
**11.** Push the committed changes in your feature branch to your remote repo. | ||
|
||
``` | ||
git push origin <your_branch_name> | ||
``` | ||
**12.** Go to your fork you will a popup saying "Compare & Pull Request" | ||
|
||
![compare&pull](https://user-images.githubusercontent.com/43697446/134040805-c114ccf9-aa14-427e-b01f-8dcb2f58ef94.png) | ||
|
||
**13.** To create a pull request, click on `compare and pull requests`. Please ensure you compare your feature branch to the desired branch of the repo you are supposed to make a PR to. | ||
|
||
|
||
**14.** Add an appropriate title and description to your pull request explaining your changes and efforts done and click on make a PR. | ||
|
||
**15.** Wait for the reviewers to approve and merge it. | ||
|
||
### And that's it, you're done! We're looking forward to having wonderful contributors with us |