diff --git a/README.md b/README.md index 8b137891..ac546973 100644 --- a/README.md +++ b/README.md @@ -1 +1,78 @@ +# Contribution is fun! :green_heart: + +In order to make a hassle-free environment, I implore you all (_while contributing_) to follow the instructions mentioned below! + +Happy Submissions :slightly_smiling_face: + +## Contribution Guidelines🏗 + +Are we missing any of your favorite features, which you think you can add to it❓ We invite you to contribute to this project and make it better. +To start contributing, follow the below guidelines: + +**1.** Fork this repository. + +**2.** Clone your forked copy of the project. + +``` +git clone https://github.com//Portfolio-Collection.git +``` + +**3.** Navigate to the project directory :file_folder: . + +``` +cd Portfolio-Collection +``` + +**4.** Add a reference(remote) to the original repository. + +``` +git remote add upstream https://github.com/avinash201199/Portfolio-Collection.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 +``` + +**8.** Perform your desired changes to the code base. + +**9.** Track 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 -u origin +``` + +**12.** To create a pull request, click on `compare and pull requests`. + +**13.** Add appropriate title and description to your pull request explaining your changes and efforts done. + +**14.** Click on `Create Pull Request`. + + +**15** Voila :exclamation: You have made a PR to the Portfolio-Collection :boom: . Wait for your submission to be accepted and your PR to be merged.(Hacktoberfest 2023)