scaleracademy / scaler-september-open-source-challenge-2022

Scaler September Open Source Challenge
324 stars 345 forks source link

First issue #310

Open taanii opened 1 year ago

taanii commented 1 year ago

name: Chaitanya Keerthi github_user_name: taanii

taanii commented 1 year ago

https://github.com/taanii/scaler-september-open-source-challenge

image

taanii commented 1 year ago

image

taanii commented 1 year ago

Challenge 4

  1. main branch

image

  1. taanii-details branch

image

taanii commented 1 year ago

Challenge 9

image

taanii commented 1 year ago

image

image

taanii commented 1 year ago

git stash command

image

taanii commented 1 year ago

Adding new file in main

image

Switching in newbranch2 and changing file contents to create merge conflict

image

Merge conflict

image

Resolved merge conflict

image image

Commands:

image

image

taanii commented 1 year ago

image

taanii commented 1 year ago

image

image

image

image

image

taanii commented 1 year ago

Cloning the repository

image

Making changes in local

image

Commit and Push

image

Pull from main

image

Pushing from newbranch

image

Pull request

image

Merging

image

image

image

taanii commented 1 year ago

Challenge 19

image

taanii commented 1 year ago

Challenge 20

Files

image

Project Board

image

taanii commented 1 year ago

Challenge 21

Git Alias

image

image

taanii commented 1 year ago

Congrats you have successfully completed milestone 2 and you are good to move onto next milestone All the best✅️

Thank youu! @kuraakhilesh8230

taanii commented 1 year ago

Challenge 22

Portfolio website live demo

image

image

image

taanii commented 1 year ago

Challenge 23

Effective Open Source Contribution

Most of the repositories have a CONTRIBUTING.md file or a markdown file, which consists of all the rules developers need to follow if they want to contribute to that particular repository.

GitHub Flow

It’s important to follow the GitHub flow for Open Source contribution

  1. Create a branch
  2. Make changes
  3. Create a pull request
  4. Address review comments
  5. Merge your pull request
  6. Delete your branch

Issues

We can create issues as a user/developer for

  1. Suggesting a feature update
  2. Error in the code

And as an Open Source Contributor, our major aim is to solve all the ISSUES listed in the repository.

We can solve issues and add it as a Pull Request.

Branches

Branches should always be created from the development branch and not the main branch.

There are some recommended branch naming conventions that we need to follow in order to maintain uniformity, so that all the developers in that organization have clear idea of what you’re working on.

image

This is the list of permanent branches which is present in all repositories:

  1. Master(master)
  2. Development(dev)
  3. Quality Assurance(QA)

The list of temporary branches in any repository are:

  1. Bug Fix - to fix bugs during production or testing phases
  2. Hot Fix - to fix errors which occur after the product is deployed and is live
  3. Feature Branches - to add any feature
  4. Experimental Branches - for experimental changes
  5. WIP branches - the branches which are still “work in progress” so that others don’t review it before it’s fully developed

Git Branching Naming Convention Rules

  1. Start branch name with a Group word
    • Bug – The bug which needs to be fixed soon
    • WIP – The work is in progress, and I am aware it will not finish soon
  2. Use Unique ID in branch names

You can use unique ids and document them, and you can also use Issue id for the branches created to fix particular Issues.

  1. Use Hyphen or Slash as Separators

Separation is necessary for readability.

  1. Git Branch with Author Name

If your project has more than two contributors, you can use your initials.

For example, I prefix ck- to all my feature branch names: git checkout -b ck-bug-tokenid

This also allows you to filter down to your personal branches with git branch -v | grep ck-

  1. Don’t use long branch names as its not convenient in the GitHub CLI

Pull Requests(PR)

  1. Give your feature branch a clear name
  2. Give your commits and PRs active and descriptive titles

For example, use “Fix dashboard typo” instead of “Fixed” or “Fixes”

  1. Streamline your process of creating a new PR
mermaid
function gpr() {
  git push origin HEAD

  if [ $? -eq 0 ]; then
    github_url=`git remote -v | awk '/fetch/{print $2}' | sed -Ee 's#(git@|git://)#http://#' -e 's@com:@com/@' -e 's%\.git$%%'`;
    branch_name=`git symbolic-ref HEAD 2>/dev/null | cut -d"/" -f 3`;
    pr_url=$github_url"/compare/main..."$branch_name
    open $pr_url;
  else
    echo 'failed to push commits and open a pull request.';
  fi
}

Use this to create a PR directly from your CLI

  1. Give your PR a meaningful description
    • "Why?" Why is this new code necessary? Providing a little extra context helps give your reviewer a clearer understanding of what they are about to be looking at.
    • "How?" Provide a bullet point list of the most important commits, expanding on each as necessary.
    • "What?" Demonstrate the functionality that was added or changed, calling out particular parts of your feature that warrant extra attention. Images and animated GIFs are a great way to do this.
  2. Show your functionality visually, whenever possible
  3. Review your own PR before you assign it to others
    • Run your tests
    • Lint your code

Writing Commit messages

Commit messages should be followed by these keywords to get a more clear understanding of what the commit is about.

Example: test: add unit test for login

taanii commented 1 year ago

Challenge 24

Updates:

image

taanii commented 1 year ago

Challenge 25

Updates:

Creating Open Source Project with other collaborators

kuraakhilesh8230 commented 1 year ago

Congratulations you have successfully completed milestone 2 and good to go ✅️

taanii commented 1 year ago

Challenge 26

Updates:

I am contributing to the following repositories:

  1. 60 seconds of CPP
  2. Hacktoberfest 2022 - MrKrishnaAgarwal
  3. Stone CSS Website

image

taanii commented 1 year ago

Challenge 27

Hacktoberfest 2022 has the following sections where you can contribute:

  1. Code contributions
  2. Non-Code contributions

Tips:

Hacktoberfest rules:

taanii commented 1 year ago

Challenge 28

Updates:

taanii commented 1 year ago

Challenge 29

Updates:

image

My project ideas

image

image

kuraakhilesh8230 commented 1 year ago

Congratulations you have successfully completed milestone 4 and I hope you have had a great experience in this 30 days and learned something about this github and open source projects 🎊🎊

taanii commented 1 year ago

Challenge 30

Scaler Open Source Challenge is when I started my open source journey. This challenge was well paced and covered almost all important concepts which are required to contribute in open source.

It was an awesome experience where I learnt GitHub and Open Source practically, by implementing everything. This practical experience gave me confidence to contribute to the real open source projects, and also helped me to learn many other skills like team work, consistency, content writing, and networking.

Scaler Discord community has also helped me a lot and I am so happy to discover and be a part of Scaler Discord community!

Special thanks to @shivaylamba for adding such great tasks to the challenge, and thanks to @kuraakhilesh8230 @TeralaShivaKumar and the other Scaler Stars for guiding me.

taanii commented 1 year ago

Congratulations you have successfully completed milestone 4 and I hope you have had a great experience in this 30 days and learned something about this github and open source projects 🎊🎊

Thank you! @kuraakhilesh8230