documentation/tools/git-setup.md
2020-08-17 21:53:36 -04:00

1.3 KiB
Raw Blame History

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 users editor of choice) generally go into a file specified by core.excludesfile in the users ~/.gitconfig (i.e. in the user's home directory). — gitignore manual page.

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 and the guidelines for commit messages. 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 virtual machine. To do so with DDEV:

ddev auth ssh