-
Notifications
You must be signed in to change notification settings - Fork 264
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #298 from Harshh18/update-readme
docs: Update README and added CONTRIBUTING.md
- Loading branch information
Showing
2 changed files
with
91 additions
and
112 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,66 @@ | ||
## To start contributing, follow the below guidelines: | ||
|
||
**1.** Fork this repository. | ||
|
||
**2.** Clone your forked copy of the project. | ||
|
||
``` | ||
git clone https://github.com/<your_user_name>/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 <your_branch_name> | ||
``` | ||
|
||
**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 <your_branch_name> | ||
``` | ||
Replace "<your_branch_name>" with a descriptive name for your branch — for example, `update-readme`. | ||
|
||
**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`. |
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