Skip to content
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.

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

docs: add git documentation #1

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

ibrahimraimi
Copy link
Contributor

No description provided.

@ibrahimraimi ibrahimraimi added the documentation Improvements or additions to documentation label Jul 30, 2022
@ibrahimraimi ibrahimraimi requested a review from aminoxix July 30, 2022 22:52
@aminoxix aminoxix requested a review from Panquesito7 August 1, 2022 10:16
@aminoxix
Copy link
Member

aminoxix commented Aug 1, 2022

requested @Panquesito7 for better docs info. to be pushed.

Copy link
Member

@Panquesito7 Panquesito7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work! Apart from all of this, all is looking perfect! 🚀

git-docs.md Outdated Show resolved Hide resolved
git-docs.md Outdated Show resolved Hide resolved
git-docs.md Outdated Show resolved Hide resolved
git-docs.md Outdated Show resolved Hide resolved
git-docs.md Outdated Show resolved Hide resolved
git-docs.md Outdated Show resolved Hide resolved
git-docs.md Outdated Show resolved Hide resolved
git-docs.md Outdated Show resolved Hide resolved
git-docs.md Outdated Show resolved Hide resolved
git-docs.md Outdated Show resolved Hide resolved
@aminoxix
Copy link
Member

@ibrahimraimi: Are you working on it?

@ibrahimraimi
Copy link
Contributor Author

ibrahimraimi commented Sep 22, 2022

@aminoxix Yeah, have made the corrections.
And am so sorry it took me this long to correct this. My sincere apologies. 🙏

@aminoxix
Copy link
Member

aminoxix commented Oct 8, 2022

@Panquesito7 keep me updated on this!

Copy link
Member

@Panquesito7 Panquesito7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are a few other changes mentioned above that can be updated as well. 🙂

git-docs.md Outdated Show resolved Hide resolved
git-docs.md Outdated Show resolved Hide resolved
Copy link
Member

@aminoxix aminoxix left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good to me! 🚀

@aminoxix
Copy link
Member

@ibrahimraimi: Do you mind updating 10, 11, and 12 points? I think that's missing..

Copy link
Member

@Panquesito7 Panquesito7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think these texts could be improved. 🙂


### 5. Initialize Git

After creating a new local repository or in an existing local repository, initialize the repository by the following command:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
After creating a new local repository or in an existing local repository, initialize the repository by the following command:
After creating a new local repository or in an existing local repository, initialize the repository by running the following command:

### 6. Add file to the staging area

The file can be added to the staging area in multiple ways.
To add a single file, we use the _git add_ command followed by a file name
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To add a single file, we use the _git add_ command followed by a file name
To add a single file, we use the `git add` command followed by a file name.

git init
```

Once, the repository is initialized git tracks the changes in the files and folders of the project.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Once, the repository is initialized git tracks the changes in the files and folders of the project.
Once the repository is initialized, Git will track the file and folder changes of the project.

git add filename
```

To add multiple files using their file names using the command _git add_ followed by file names
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To add multiple files using their file names using the command _git add_ followed by file names
To add multiple files using their file names, use the command `git add` followed by their file names.

Comment on lines +78 to +80
Sometimes, we make a lot of changes, and adding files one by one is time consuming. Therefore, we can use a short and productive way. The _git add_ command followed by a dot allows adding files and folders at once to the staging area. Remember, there is a space between the add and the dot.

To add all files and folders at once
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Sometimes, we make a lot of changes, and adding files one by one is time consuming. Therefore, we can use a short and productive way. The _git add_ command followed by a dot allows adding files and folders at once to the staging area. Remember, there is a space between the add and the dot.
To add all files and folders at once
If you wanna stage all of your Git changes, there's a quicker and more efficient way to do that. This is very useful if you have lots of changes or you just want to stage them all quicker.

```
Your commit message has to be associated with the changes or modifications you make.

To add and commit at the same time
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To add and commit at the same time
If you wanna commit and add at the same time, run the following command.


### 9. Git log

The _git log_ command allows you to check the commit history of the project. It list down all the commit history
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The _git log_ command allows you to check the commit history of the project. It list down all the commit history
The `git log` command allows you to check the history of the project. It'll list down all the commit history.


### 13. Creating a branch

Branch in Git is similar to the branch of a tree. Analogically, a tree branch is attached to the central part of the tree called the trunk. While branches can generate and fall off, the trunk remains compact and is the only part by which we can say the tree is alive and standing. Similarly, a branch in Git is a way to keep developing and coding a new feature or modification to the software and still not affecting the main part of the project. We can also say that branches create another line of development in the project. The primary or default branch in Git is the main branch (similar to a trunk of the tree). As soon as the repository creates, so does the main branch (or the default branch).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Branch in Git is similar to the branch of a tree. Analogically, a tree branch is attached to the central part of the tree called the trunk. While branches can generate and fall off, the trunk remains compact and is the only part by which we can say the tree is alive and standing. Similarly, a branch in Git is a way to keep developing and coding a new feature or modification to the software and still not affecting the main part of the project. We can also say that branches create another line of development in the project. The primary or default branch in Git is the main branch (similar to a trunk of the tree). As soon as the repository creates, so does the main branch (or the default branch).
Branches in Git are similar to the branch of a tree. Analogically, a tree branch is attached to the central part of the tree called the trunk. While branches can generate and fall off, the trunk remains compact and is the only part by which we can say the tree is alive and standing. Similarly, a branch in Git is a way to keep developing and coding a new feature or modification to the software and still not affecting the main part of the project. We can also say that branches create another line of development in the project. The primary or default branch in Git is the main branch (similar to the trunk of a tree). As soon as the repository creates, so does the main branch (or the default branch).

@aminoxix
Copy link
Member

@ibrahimraimi I made some changes that's mentioned by @Panquesito7, so you have to pull the latest change in your branch, & try to accomplish it asap!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants