Initial commit

This commit is contained in:
Sirin Puenggun 2023-08-20 23:43:44 +07:00 committed by GitHub
commit 0665dffc23
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 264 additions and 0 deletions

213
README.md Normal file
View File

@ -0,0 +1,213 @@
**TODO**: Delete these instructions before you submit your work.
## Instructions
1. Read Chapters 2 & 3 of [Pro Git][ProGit]. The chapters are short.
2. Answer these questions using [Markdown format][markdown-cheatsheet] (also [Github Markdown][github-markdown]).
3. Place your answers between lines beginning with 3 backquotes, which tells Markdown it should be unformatted text, and write only the commands you would type (**no** shell prompt). E.g.:
```
git status CORRECT
$ git status WRONG - you do not type "$"
```
4. Indent the 3 backquotes so they line up with the question text (3 leading spaces) so Markdown formats you answer as part of the numbered item.
Example:
```
git init
```
5. **Test that your answers are correct!** There is **no excuse** for incorrect answers since you can test your answers by experimentation.
6. Verify that your Markdown formatting is correct -- points deducted for bad formatting. VS Code and IntelliJ have markdown previewers. You should also preview it on Github, since Github Markdown is a bit non-standard.
**TODO**: Delete these instructions before you submit your work. Points deducted for each "TODO" in this file.
## Using Git
[Basics](#basics)
[Adding and Changing Things](#adding-and-changing-things)
[Undo Changes and Recover Files](#undo-changes-and-recover-files)
[Viewing Commits](#viewing-commits)
[Branch and Merge](#branch-and-merge)
[Commands for Remotes](remote-commands.md)
[Favorites](#favorites)
[Resources](#resources)
#### Note on Paths
In this file, directory paths are written with a forward slash as on MacOS, Linux, and the Windows-Bash shell: `/dir1/dir2/somefile`.
## Basics
1. When using Git locally, what are these? Define each one in a sentence
* Staging area -
* Working copy -
* master -
* HEAD -
2. When you install git on a new machine (or in a new user account) you should perform these 2 git commands to tell git your name and email. These values are used in commits that you make:
```
# Git configuration commands for a new account
```
3. There are 2 ways to create a local Git repository. Briefly descibe each one:
- todo: describe first way to create a local repo
- todo: describe second way to create a local repo
## Adding and Changing Things
Suppose your working copy of a repository contains these files and directories:
```
README.md
out/
a.exe
src/a.py
b.py
c.py
test/
test_a.py
...
```
> TODO: Write the git command to perform each of these:
1. Add README.md and *everything* in the `src` directory to the git staging area.
```
todo your answer here
```
2. Add `test/test_a.py` to the staging area (but not any other files).
```
todo your answer
```
3. List the names of files in the staging area.
```
todo your answer
```
4. Remove `README.md` from the staging area. This is **very useful** if you accidentally add something you don't want to commit.
```
todo your answer
```
5. Commit everything in the staging area to the repository.
```
todo your answer
```
6. In any project, there are some files and directories that you **should not** commit to git.
For a Python project, name *at least* files or directories that you should not commit to git:
-
-
-
7. Command to move all the .py files from the `src` dir to the top-level directory of this repository. This command moves them in your working copy *and* in the git repo (when you commit the change):
```
```
8. In this repository, create your own `.gitignore` file that you can reuse in other Python projects. Add everything that you think is relevant.
*Hint:* A good place to start is to create a new repo on Github and during the creation dialog, ask Github to make a .gitignore for Python projects. Then edit it. Don't forget to include pytest output and MacOS junk.
## Undo Changes and Recover Files
> TODO: enter the git command to do each of these
> For questions where you are showing a command, use triple-backquote marks (as above) so the text is formatted as code.
1. Display the differences between your *working copy* of `a.py` and the `a.py` in the *local repository* (HEAD revision):
2. Display the differences between your *working copy* of `a.py` and the version in the *staging area*. (But, if a.py is not in the staging area this will compare working copy to HEAD revision):
3. **View changes to be committed:** Display the differences between files in the staging area and the versions in the repository. (You can also specify a file name to compare just one file.)
4. **Undo "git add":** If `main.py` has been added to the staging area (`git add main.py`), remove it from the staging area:
5. **Recover a file:** Command to replace your working copy of `a.py` with the most recent (HEAD) version in the repository. This also works if you have deleted your working copy of this file.
6. **Undo a commit:** Suppose you want to discard some commit(s) and move both HEAD and "master" to an earlier revision (an earlier commit) Suppose the git commit graph looks like this (`aaaa`, etc, are the commit ids)
```
aaaa ---> bbbb ---> cccc ---> dddd [HEAD -> master]
```
The command to reset HEAD and master to the commit id `bbbb`:
7. **Checkout old code:** Using the above example, the command to replace your working copy with the files from commit with id `aaaa`:
```
todo your answer here
```
Note:
- Git won't let you do this if you have uncommitted changes to any "tracked" files.
- Untracked files are ignored, so after doing this command they will still be in your working copy.
## Viewing Commits
1. Show the history of commits, using one line per commit:
```
git log --oneline
```
Some versions of git have an *alias* "log1" for this (`git log1`).
2. Show the history (as above) including *all* branches in the repository and include a graph connecting the commits:
```
```
3. List all the files in the current branch of the repository:
```
todo your answer
```
Example output:
```
.gitignore
README.md
a.py
b.py
test/test_a.py
test/test_b.py
```
## Branch and Merge
**TODO**: This section is free-form. Create 4 numbered items for common branch-and-merge tasks you would like to remember and show the git command to do each one. (You are write *more* than 4 if you want.)
## Favorites
> TODO: Describe *at least* 1 task that you would like to remember, and the git command(s) to do it.
---
## Resources
> TODO: Add your favorite Git resources (at least 1)
* [Pro Git Online Book][ProGit] Chapters 2 & 3 contain the essentials. Downloadable e-book is available, too.
* [Visual Git Reference](https://marklodato.github.io/visual-git-guide) one page with illustrations of git commands.
* [Markdown Cheatsheet][markdown-cheatsheet] summary of Markdown commands.
* [Github Markdown][github-markdown] some differences in the way Github handles markdown and special Markdown for repos.
Learn Git Visually:
* [Learn Git Interactive Tutorial][LearnGitInteractive] great visual tutorial
* [Git Visualizer][VisualizeGit] execute Git commands in a web browser and see the results as a graph.
[ProGit]: https://www.git-scm.com/book/en/v2 "Pro Git online book on Git-scm.com"
[ProGitPdf]: https://progit2.s3.amazonaws.com/en/2016-03-22-f3531/progit-en.1084.pdf "Pro Git v.2 PDF on AWS. Longer, book format."
[LearnGitInteractive]: https://learngitbranching.js.org "Interactive graphical git tutorial"
[VisualizeGit]: http://git-school.github.io/visualizing-git/ "Online tools draws a graph of commits in a repo as you type"
[markdown-cheatsheet]: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
[github-markdown]: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax

51
remote-commands.md Normal file
View File

@ -0,0 +1,51 @@
## Commands for Remotes
> TODO Write your answers and then remove **all** the TODO comments
```
1. List all your remote repositories and show their URLs:
```
Todo write the git command for this
```
2. View details about a remote repo named `origin`, including all the remote branches and local tracking branches for `origin`:
```
Todo write the git command for this
```
3. (Pushing a new branch) You commit some files to the `dev-foo` branch and try to "push" them to Github, but it fails as shown here:
```
cmd> git checkout dev-foo
cmd> git push
fatal: The current branch dev-foo has no upstream branch.
```
Explain this error.
> TODO Since you are writing an explanation (not shell commands), write your answer in lines beginning with `>` like this one. The text will be formatted and may include Markdown.
4. The command to push `dev-foo` to `origin` as a **new remote branch** on `origin` is:
5. (Create a local tracking branch for a remote branch) The remote repository (`origin`) has a branch named `e2e-test` that you don't have in your local repository.
The command to create a new local branch as a copy of the remote `e2e-test` branch that **tracks** the remote branch is:
```
Todo There are many commands that will do this. You may write one or more than one.
```
6. The command to change the URL of the remote "origin" to a new URL, such as `https://hostname/newuser/new-repo-name`, is:
```
TODO your answer
```
This situation occurs when:
- you change the name of a repo on Github
- you transfer ownership of a Github repo to someone else
- you move from Github to another hosting site, like Bitbucket
- you want to switch from the https to the ssh protocol (the remote URL is different)
8. To create a *second* remote repository for your local repo, the command to add a remote named "bitbucket" with the URL "https://bitbucket.org/your-username/git-commands" is:
```
todo your answer
```
- Note: you must **create** an empty repo on Bitbucket. This command just adds it as a remote, it won't create the remote repo.