From f828c52f5ca5c61868b8ff32ccac4e31ec27aef7 Mon Sep 17 00:00:00 2001 From: Kislay Date: Tue, 28 May 2024 17:46:12 +0530 Subject: [PATCH] docs: added note for git reset --- CONTRIBUTING.md | 5 ++--- CONVENTIONS.md | 1 + 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cdada3b..1840cdb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,3 @@ - --- # Contributing to Multiplayer UNO Game @@ -91,7 +90,7 @@ If any merge conflicts occur, you will need to resolve them manually. Code edito Now the local copy of the branch is synced with upstream/main. You need to force push these changes to origin, since the commit history has been rewritten. ```bash -git push origin --force +git push --force ``` ### Editing commit history @@ -135,7 +134,7 @@ After making the changes, you can continue the rebase process by running `git re When there are no more commits left, the rebase process will be complete. -After all the commits have been applied, you can push the changes to your branch using `git push origin --force`. This will overwrite the commits in the remote branch in your forked repository with the changes you just made locally. +After all the commits have been applied, you can push the changes to your branch using `git push --force`. This will overwrite the commits in the remote branch in your forked repository with the changes you just made locally. #### Tip VSCode provides a helpful UI to perform these operations. You can set the default text editor for Git to VSCode by running the following command: diff --git a/CONVENTIONS.md b/CONVENTIONS.md index 23bfdd1..10f6a1d 100644 --- a/CONVENTIONS.md +++ b/CONVENTIONS.md @@ -20,6 +20,7 @@ - Use meaningful commit messages that describe the changes made in the commit. - Please do only one thing in a single commit. If you are fixing a bug and refactoring some code, make two separate commits. - If you make tweaks to existing code to fit your implementation, do it in a separate commit. +- Your commits would be more readable if each line is limited to around 72 characters. Break long lines into multiple lines if necessary. - Commit messages should be of the format: ``` :