From 4bc2e73940f3d227619199b38809bf7c20e658a8 Mon Sep 17 00:00:00 2001 From: "Bradley M. Kuhn" Date: Sat, 28 Apr 2012 14:17:07 -0400 Subject: [PATCH] Newly created HACKING file should link to canonical developer info on wiki. Signed-off-by: Bradley M. Kuhn --- HACKING | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/HACKING b/HACKING index f95ab12dcf..f270c58661 100644 --- a/HACKING +++ b/HACKING @@ -3,9 +3,19 @@ HACKING File for Evergreen :toc: :numbered: +Contributing +------------ +A +http://evergreen-ils.org/dokuwiki/doku.php?id=contributing[tutorial for contributing to Evergreen is on the Evergreen Wiki]. + +Git +--- + +The +http://evergreen-ils.org/dokuwiki/doku.php?id=dev:git[Git workflow used by the project is documented on the Evergreen Wiki]. Git Ignores ------------ +~~~~~~~~~~~ The +.gitignore+ file for the project level should only have files that are generated by the build or install processes of Evergreen itself. @@ -16,7 +26,7 @@ autosave files. Evergreen recommends putting this not in the project's Below is how to do this for various editors. Creating A Global Git ignore file -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ A useful tutorial on this issue can be found http://programblings.com/2008/10/22/git-global-ignores/[in this blog post]. The basic, command, however, is as follows: @@ -29,7 +39,7 @@ git config --global core.excludesfile /path/to/my/global/gitignore Many people like to use +~/.gitignore+ for +/path/to/my/global/gitignore+. Git Ignore Emacs Autosave/backup files -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ To ignore Emacs autosave/backup files, put the following lines in your +/path/to/my/global/gitignore+ file. @@ -42,7 +52,7 @@ Note the need of a backslash before the pound sign above, which is needed since pound usually is a comment in a +gitignore+ file. Git Ignore Vim Autosave/backup files -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ To ignore vim autosave files, put the following lines in your +/path/to/my/global/gitignore+ file. -- 2.11.0