[Docs] - ofBook/chapters/version_control_with_git/chapter.md - fixing document#282
Conversation
… document #### [Docs] - ofBook/chapters/version_control_with_git/chapter.md - fixing document
| The basic element for tracking the history of the repository is the **commit**. | ||
| This is basically a snapshot of the repository's state at the time of the commit, including a **commit message** and any parent commit(s). | ||
| Think of it as a checkpoint for saving in a videogame. | ||
| This is basically a snapshot of the repository's state at the time of the commit, including a **commit message** and any parent commits (s). |
There was a problem hiding this comment.
I think the old version "commit(s)" is correct since the sentence points to a single or maybe multiple commits. A free standing "(s)" has no meaning in this (new) context.
|
|
||
| It's important that the Git repository contains all files necessary to successfully compile our program, but no unnecessary stuff. | ||
| Generally, this means that files we edit by hand (e.g. source and header files, Readme files, images,...) should be included in the repository, but files which are *generated from* our code (e.g. compiled binaries, pdfs generated from some source file, video files or image sequences created with our program) should stay out. | ||
| Generally, this means that files we edit by hand (e.g. source and header files, Readme files, images,...) should be included in the repository, but files which are *generated from* our code (e.g. compiled binaries, pdf generated from some source file, video files or image sequences created with our program) should stay out. |
There was a problem hiding this comment.
Multiple pdf files may be generated from one source file, so I lean slightly towards the plural form, but only slightly.
| #### Pull requests | ||
|
|
||
| A central feature of the Gitub collaboration model are [**pull requests**](https://help.github.com/articles/using-pull-requests). | ||
| A central feature of the GitHub collaboration model is [**pull requests**](https://help.github.com/articles/using-pull-requests). |
There was a problem hiding this comment.
either "are" (as in the old version) or "pull request" for the new version
|
Looks good, only tiny issues to fix. |
|
@tpltnt i alredy fixed everything you asked for. shall we proceed with merging? cheers |
|
They look good to me, but I don't have the permission(s) to merge :( |
| #### `.gitignore` | ||
|
|
||
| One thing we should do right at the beginning is add a special Git file called [`.gitignore`](http://git-scm.com/docs/gitignore) to the root of our repository. | ||
| One thing we should do right at the beginning adds a special Git file called [`.gitignore`](http://git-scm.com/docs/gitignore) to the root of our repository. |
There was a problem hiding this comment.
sounds odd. I'd rather say "is to add" or "is adding" instead of "adds"
| Those ignored files will still exist in our working directory, that means we can still use them, but Git will not track them. | ||
|
|
||
| If, later down the line, we see files appearing in our list of changes which should not be there, or if we can't seem to add a file that belongs in the repository, we don't force Git to do what it doesn't want to, rather fine-tune the `.gitignore` pattern to match our expectations. | ||
| If later down the line, we see files appearing in our list of changes which should not be there, or if we can't seem to add a file that belongs in the repository, we don't force Git to do what it doesn't want to, rather fine-tune the `.gitignore` pattern to match our expectations. |
There was a problem hiding this comment.
I'd say that it was correct with the comma
| $ git status | ||
| # On branch master | ||
| # Changes not staged for commit: | ||
| # Changes are not staged for commit: |
There was a problem hiding this comment.
This should be as it was! it is what git outputs.
| ```bash | ||
| $ git diff | ||
| diff --git a/src/ofApp.cpp b/src/ofApp.cpp | ||
| $ git diff --git a/src/ofApp.cpp b/src/ofApp.cpp |
There was a problem hiding this comment.
same here. It was correct before. it is what thegit diff command will output and not extra arguments for it.
|
hey guys. i replaced my previous account by this one, for some issues (too many repositories, et al(. if i can fix push access to this post i will be fixing things as soon as possible. thank you for feedback and for your patience. cheers |
|
@roymacdonald @tem44 what's the status of this PR? |
|
Hi there. I think I missed the notification for @edap 's last comment. |
3 participants
[Docs] - ofBook/chapters/version_control_with_git/chapter.md - fixing document