Skip to content

[Documentation ]: Updating Contributing.mg #164

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[Documentation ]: Updating Contributing.mg #164

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,41 +20,60 @@ Please note we have a code of conduct, please follow it in all your interactions
## Git Flow

1. Navigate to the [CatsInTech/Rezume](https://github.com/CatsInTech/Rezume/tree/master) repository and click on Fork button.

![Step 1](./docs/1-sBicOjJ.png)
2. You'll either find a way to fork to your own account or you will have a link to go to your forked repository. Clicking on either takes you to the forked repository.

![Step 2](./docs/2-8R63Krl.png)
3. You can confirm that this repository is a fork of the original repository by finding the "forked from [CatsInTech/Rezume](https://github.com/CatsInTech/Rezume)" text under the repository name.

![Step 3](./docs/3-LN2fgMH.png)
4. Click on Clone or download button on the forked repository. Make sure you are cloning your version (GitHub.com/\<your username>/Rezume) and not the CatsInTech organisation's.

![Step 4](./docs/4-137utKt.png)
5. I use a `git clone` command with my username attached in front of the `github.com`, making the clone command look like `git clone https://[email protected]/praveenscience/Rezume.git`. This is for making sure, the compatibility is maximum.

![Step 5](./docs/5-C9bX69B.png)
6. Let's say I am going to start working on the `Issue #2`. Create a new branch with the format of `issue#-subject`, here it is `2-cname-update`. I use command line a lot so I am confident of what command I am using. If you're comfortable with GUI, feel free to use it, but make sure you use the right naming convention. The complete command I have used here is `git checkout -b 2-cname-update`.
![Step 6](./docs/6-05XgdIa.png)

7. Make all your changes in your favourite IDE. Make sure you adhere to the linting rules given in [My Personal Development Environment](https://blog.praveen.science/my-personal-development-environment/) blog post, under Visual Studio Code. There's also [My Visual Studio Code Settings](https://gist.github.com/praveenscience/ebb5439f31774ad2fdc14cb9e7de1fc0) with all the extensions I use. You don't need to use all but make sure you follow the prettier guidelines at least, which will have mostly the default ones like double quotes, no trailing quotes and spaces, line width of 80 characters or less, etc. If you have issues setting up your development environment, please contact me.

8. Once you make changes, you can see the changed files. Make sure no unintended changes are there (new files added, changed files aren't recognised, etc.), which you can see by checking the `git status` command and looking at the workspace.

![Step 7](./docs/7-AKOFOlf.png)
9. Use a good diff tool to check if the changes are indeed intended. I use `git diff --color` to check the diffs between the changes.

![Step 8](./docs/8-TQ5dz2W.png)
10. If everything looks alright, add the files to staging by using `git add <filename>`. If you want to add all the files and if there are many files, you can use `git add .`. Use `git status` again to verify the changes that are added.

![Step 9](./docs/9-O5XQayC.png)
11. Once you have added the files to staging and checked the integrity of changes, you can start writing the commit message. The commit message should follow [Git Standards followed in our way of Spotify Agile Methodology](https://blog.praveen.science/git-standards-followed-in-our-way-of-spotify-agile-methodolgy/). The main two points you need to note are 50 characters for commit subjects and 72 characters for commit message lines. At the end of the commit message, make sure you write `Fixes #<issue number>.`. We are following sentence case everywhere and a past tense. Please follow the same. When you push for the first time, please use the `-u` flag and give the full branch name. As my branch name is `2-cname-update` and this is the first time I am pushing, I will do `git push -u origin 2-cname-update`. Once you do this, the command automatically gives you the link for creating Pull Request as a response from remote. In my case, it was `https://github.com/praveenscience/Rezume/pull/new/2-cname-update`.

![Step 10](./docs/10-3xfLpVi.png)
12. Either navigate to the URL that you received in the above step or just go to your repository. You can see a banner informing you about your recently pushed branches and will also give you an option to Compare & pull request. Click on the button to open the pull request.
12. Either navigate to the URL that you received in the above step or just go to your repository. You can see a banner informing you about your recently pushed branches and will also give you an option to Compare & pull request. Click on the button to open the pull request.

![Step 11](./docs/11-4x9AWKJ.png)
13. In the Open a pull request page, you will be shown with the commit details. Make sure you enter a valid commit message explaining what you have done and give a few points on what has happened. Don't forget to add the last line `Fixes #<issue number>.` at the end. Also, make sure to notify the mentors & admin of the project by clicking on the gear icon next to Reviewers on the right side. Click on Create pull request to create the pull request for review.

![Step 12](./docs/12-G46c2NH.png)
14. Here you have created the pull request successfully. You can check the correct number of commits and the files changed are perfect here. One of the reviewers will be with you shortly to check the Pull Request and gives you feedback, if there are any.

![Step 13](./docs/13-y678XLN.png)
15. Once the pull request looks satisfying to the maintainers / mentors, your pull request will be merged. You may (or may not) delete your branch at this moment.

![Step 14](./docs/14-6PU2f9C.png)
16. After merging new code into the `CatsInTech/Rezume` repository, your fork's `master` branch might be outdated. To make sure your `master` branch is latest, you need to pull the latest code from the upstream repository `CatsInTech/Rezume` to your local machine's `master` branch and then push to your origin repository `<your username>/Rezume`.

![Step 15](./docs/15-QoHjRbD.png)
17. To do the above step, you need to add the remote upstream as `upstream` in `git remote`. **Make sure you do this only once.** This is a repository level configuration, which means, you **don't need** to do it every time you create a new branch. I use this command `git remote add upstream https://[email protected]/CatsInTech/Rezume.git` to add the upstream repository. Make sure your `upstream` repository points to `CatsInTech/Rezume` while your `origin` repository points to `<your username>/Rezume`. You can check that by entering the `git remote -v` command.

![Step 16](./docs/16-CMQpqr1.png)
18. The first step is to pull from the `upstream` and second step is to push to the `origin`. Remember, `upstream` is the author's and `origin` is yours and you are updating your `origin`'s `master` branch with the latest code from `upstream`'s master branch. To do this, check out to master branch by using `git checkout master`, pull the latest code from the upstream's repository by using `git pull upstream master` (at this point, your local is sync'd with author's repo) and update your forked repository's master branch by using `git push`. If you follow the instructions correctly, there shouldn't be any issues pushing, but if you encounter any issues, I'll create a new section, commonly encountered issues, which you may refer. The above said three commands should give you a result like below.

![Step 17](./docs/17-TLdzlD3.png)
19. Now after pushing the changes, if you check your forked repository in GitHub, you must be able to see `This branch is even with CatsInTech:master.`. If that's not present, then either you haven't pushed it yet or you aren't in the master branch.

![Step 18](./docs/18-78E0Tlk.png)
20. Now this way, your local `master` branch is in sync with the `upstream`'s repository. If you want to work on a new issue, create a new branch by using `git checkout -b <issue number>-subject`. In my case, for my Issue #19, I am going to use this command, `git checkout -b 19-contributions-doc`. Start working and then go to step #6 again and repeat.
![Step 19](./docs/19-yPeegEW.png)
Expand Down
Loading