Document using Git (moved from standard project README
This commit is contained in:
parent
c0ae777530
commit
920bbf1402
1 changed files with 27 additions and 0 deletions
27
tools/git-setup.md
Normal file
27
tools/git-setup.md
Normal file
|
@ -0,0 +1,27 @@
|
||||||
|
# Git setup
|
||||||
|
|
||||||
|
|
||||||
|
## Tell git who you are
|
||||||
|
|
||||||
|
```
|
||||||
|
$ git config --global user.name 'Jean R. Hacker'
|
||||||
|
$ git config --global user.email 'jean@agaric.com'
|
||||||
|
```
|
||||||
|
|
||||||
|
## Create a personal excludesfile (optional)
|
||||||
|
|
||||||
|
```
|
||||||
|
$ touch ~/.gitignore
|
||||||
|
$ git config --global core.excludesfile ~/.gitignore
|
||||||
|
```
|
||||||
|
|
||||||
|
Patterns which a user wants git to ignore in all situations (e.g., backup or temporary files generated by the user’s editor of choice) generally go into a file specified by core.excludesfile in the user’s ~/.gitconfig (i.e. in the user's home directory). — [gitignore manual page.](https://git-scm.com/docs/gitignore)
|
||||||
|
|
||||||
|
|
||||||
|
## Develop
|
||||||
|
|
||||||
|
Pick a ticket, create a branch referencing the ticket number, e.g. `git checkout -b project-123`. Commit your code in small chunks capturing logical steps and follow the [Drupal coding standards](https://drupal.org/coding-standards) and the [guidelines for commit messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). All configuration that accompanies your code, e.g. creating fields and content types, must be in the `config` directory or scripted in an update hook. Once your work is done request a review and eventually your code will get merged into the master branch.
|
||||||
|
|
||||||
|
Note: you may need to add your ssh key in the vagrant machine. To do so, inside the repo but outside of the vm, run the `ssh-add` command.
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue