Your ultimate guide

About GitHub & Setup

About GitHub & Setup


GitHub:
    GitHub is a web-based code hosting platform for software development and version control using Git. Git is a distributed version control system that helps developers manage and track changes in their code during the development process.
    GitHub allows developers to store their code repositories, collaborate with other team members or contributors, and manage projects efficiently. It provides features such as issue tracking, pull requests, code review, wikis, and actions for continuous integration and deployment.

    Similarly, like GitHub, there are other Source code Management(SVM) Tools are there like GitLab, Bit Bucket Server, SVN(Apache Sub Version), CVS(Concurrent Version System), TFS(Team Foundation Server), and so on.
* In Azure they have their own Source Code Management Tool Called Azure Repos.

Here are some key features and functionalities of GitHub:
  1. Repository: A repository (repo) is a storage space where a project's code and related files are stored. It's a central place for collaboration and version control.
  2. Version Control: GitHub uses Git for version control, enabling developers to track changes to their code, work on different branches, merge changes, and roll back to previous versions if needed.
  3. Collaboration: GitHub allows multiple developers to work on the same project simultaneously. Developers can create branches to work on specific features or fixes and merge them back into the main branch (often called "master" or "main").
  4. Issues and Pull Requests: Users can report issues or bugs in a repository, and developers can address them by creating pull requests with proposed code changes. Pull requests allow for code review and discussion before merging changes into the main branch.
  5. Code Review: GitHub facilitates collaborative code review, enabling team members to review proposed changes, comment on code, suggest improvements, and approve or request further modifications.
  6. Actions: GitHub Actions automates software development workflows, including build, test, and deployment processes. Users can create custom workflows or use pre-defined Actions to streamline their development workflow.
  7. Wikis and Documentation: GitHub provides a wiki feature for creating and maintaining project documentation, which is useful for explaining project structure, processes, or usage.
  8. Community and Social Interaction: GitHub has a strong community of developers who contribute to open-source projects, share code, collaborate, and discuss various topics related to software development.




GitHub Setup
Steps to Setup GitHub:
  1. To begin, the first thing you should do is create a GitHub account.
  2. Afterwards, you can create an organization within your account.
  3. After setting up the organization, you can then create a repository for your project.
  4. Once the repository is created, you can create teams within your organization.
  5. As needed, you can add members to each team.
  6. Lastly, you should grant the appropriate team access to the repository so they can contribute to your project.

Step 1: Create a GitHub account
  • Go to GitHub's official website. https://github.com
  • Click on the Sign up button.
  • Then on the next page give your personal details:
    • Email Id:
    • Create Password:
    • Enter a username:
    • Verify your account : (Please solve the simple puzzle to verify that you are human)
    • Then Click on the Create account Button.
  • Verify the email by entering the code: You'll receive an email with a code(or OTP) from GitHub. Enter that code on this verification page, then click Continue.
  • GitHub displays a quick survey, you can also skip this survey by clicking Skip personalization.
  • On the plan selection page, choose the free plan.

Step 2: Create Organization
    Within the organization, we can create repositories.
  • To create an Organization, first, you need to log in to your GitHub Account.
  • Then on the top right corner, we will see the "+" symbol, Click on that one.
  • Then select New Organization.

  • Then we will see three different plans (1. Free, 2. Team, 3. Enterprise)


  • Click on Free (Create a free Organization)
  • On the Next page, Setup your organization details:
    • Organization Account name* : <Give your organization name>
    • Contact email*: <Enter your email id>
    • This organization belong to: <Select "My personal account">
    • Verify your account by solving the simple puzzle.
    • Click on Next.
    • Then Click on Complete Setup.

Step 3: Create a Repository
   A repository is a location where we store all the source code and revise each file history.
  • In your GitHub account, in the top right corner, we will see the "+" symbol, Click on that one.
  • Select New repository.



  • Fill in all the details.
    • Owner*: < Select your Organization in Dropdown >
    • Repository name*: < Give the repository Name >
    • Description (optional): < Optional >
    • Select one option either Public or Private
      • Public < Selecting this option for Anyone on the internet can see this repository. You choose who can commit. >
      • Private < Select this option for You choose who can see and commit to the repository >


    • Initialize this repository with: < Don't select any option >
    • Click on the Create repository button.
    • Like this, we can create any number of repositories in a single organization.

Step 4: Create a Team
    A Team is a group of individuals (GitHub users) brought together within an organization to collaborate on repositories and projects more effectively. Teams help in organizing members, controlling access, and managing permissions within an organisation.
  • Open your Organization(click on your profile, then click on Your Organizations, Select your Organizations).
  • Then click on the Teams option.
  • Then Click on New team.


  • Fill in all details:
    • Team name: < Give the name of your team >
    • Description: < Optional  >
    • Team visibility: Select one option. The Team can be visible or secret
      • Visible: < Visible teams can be viewed and @mentioned  by every organization member.>
      • Secret: < Secret teams are only visible to the people on the team and people with owner permissions.>
    • Then click on Create team.

Step 5: Add Users to the Team
  • Open your Organization and click on 👥Teams.
  • Then click on your Team.
  • Then Select the Members option and Select the Add a member button.
  • Invite the Users by username, full name, or email address

  • After Creating a team we can also give the individual role to the users like Maintainer, Member
    • Maintainer: Can add and remove team members and create child teams.
    • Member: Has no administrative permissions on the team.

Step 6: Provide Repository Access to team
  • Open your team, then Click on Repositories.
  • Then click on the Add repository button, and type your repository name that we going to access to the team.



  • Then click on Add repository to team

  • After Providing repository access to the team, we can give the Permission level to access the repository by default it will be Read permission. If you want we can change the permission level.
    • Permission Level:
      • Read: Can read and clone this repository. Can also open and comment on issues and pull requests.
      • Triage: Can read and clone this repository. Can also manage issues and pull requests.
      • Write: Can read, clone. and push to this repository. Can also manage issues and pull requests.
      • Maintain: Can read, clone and push to this repository. They can also manage issues, pull requests, and some repository settings.
      • Admin: Can read, clone, and push to this repository. Can also manage issues, pull requests, and repository settings, including adding collaborators.



  • Just click on the permission you want it will apply to that team.

No comments:

Post a Comment