Hit the ground running

[PhobiaCide]

Welcome to Incomplete Infinity GitHub Repository

Introduction To GitHub

Details About Github

Visual Explanation

The diagram below is called a git graph. It is a visual representation of a project's commit history. It shows a single commit in the 'main' branch. The tag displays the commit's unique identifier.

gitGraph
   commit

Loading

When anyone pushes code to a repository, a new commit is created. For security, many repositories prohibit committing code directly to the main branch.

gitGraph
        commit
        commit

Loading

Typically, when a user wants to contribute to a project, they will fork the project at a given commit, making a new branch. Switching to a particular branch is called checkout.

gitGraph
        commit
        commit
        branch AwesomeFeature
        checkout AwesomeFeature

Loading

The branches depicted are named, 'main', and, 'AwesomeFeature' but can be named anything. Now, the users writes some code and commits to the branch they made.

gitGraph
        commit
        commit
        branch AwesomeFeature
        checkout AwesomeFeature
        commit

Loading

They can make as many commits as they like. It's a great way to not only back up your work, but also to make it accessible from multiple computers.

gitGraph
        commit
        commit
        branch AwesomeFeature
        checkout AwesomeFeature
        commit
        commit
        commit

Loading

When finished, a user might opt to initiate a pull request. This sends a message to the repository owner and/or authorized individuals and provides a means to reconcile differences in the code (conflicts).

gitGraph
        checkout main
        commit
        commit
        branch AwesomeFeature
        commit
        commit
        commit
        checkout main
	    merge AwesomeFeature id:"pull request"

Loading

Uh-oh! What happens when multiple users commit work to the same repo?

gitGraph
        checkout main
        commit
        commit
        branch AwesomeFeature
        commit
        commit
        commit
        checkout main
        branch FeatureA
	    checkout FeatureA
        commit
        checkout main
        merge AwesomeFeature
        merge FeatureA

Loading

No sweat! each branch gets a separate merge and the owners decide what code gets kept. What if two or more people want to collaborate on a feature?

gitGraph
        checkout main
        commit
        commit
        branch AwesomeFeature
        checkout AwesomeFeature
		commit
		branch Helper
		checkout main
		commit id:"Breaking Changes"
		checkout AwesomeFeature
		merge main
		checkout Helper
		merge main
	    checkout AwesomeFeature
	    merge Helper id:"pull request"
		checkout main
        merge AwesomeFeature

Loading

Above, the helper forks the branch the user made, the owners release a patch which both our user and helper are able to pull independent of the other. When the helper has finished a pull request is made on our user's branch. Once approved (by our user), the code is pushed to main

GitHub Recap

GitHub.com provides a means for users to:

1. download a project (clone)
2. create a copy of a particular version for editing (branch) or experimenting (fork)
3. upload new code to their branch of a repository(push)
4. notify project managers of new code and desire to reconcile (merge) it with the main branch (pull request)

2. Clone a Repository

Clone a repository using:

git clone https://github.com/organization/repository.git

Cloning allows you to have a local copy of the repository to work on.

3. Create a Branch

Create a new branch for your work:

git checkout -b your-feature-branch

Branching helps you work on isolated features or fixes without affecting the main codebase.

4. Make Changes and Commit

Make changes to the code and commit them with descriptive messages:

git add .
git commit -m "Fix issue #123: Add feature XYZ"

Clear commit messages make it easier to track changes and understand their purpose.

5. Push Changes to GitHub

Push changes to your branch on GitHub:

git push origin your-feature-branch

Pushing updates your remote branch on GitHub, making your changes visible to others.

6. Create a Pull Request

Create a pull request for your changes on GitHub.

Pull requests initiate discussions and reviews for your proposed changes.

7. Review and Merge

Wait for review, make any necessary changes, and once approved, merge your changes.

Reviews ensure code quality and collaboration before merging into the main branch.

Checking a Repo for Deployment

Deployments Tab

1. Open the repository on GitHub.
2. Navigate to the "Deployments" tab.

Checking deployments is crucial for ensuring that changes are successfully deployed.

Deployment Status

Review the status and logs to ensure a successful deployment.

Understanding deployment status helps identify and fix any issues promptly.

Additional Resources

• GitHub Docs
• GitHub Learning Lab
• GitHub CLI Guide

Feel free to reach out if you have any questions or need further assistance! Happy coding!