HACKING

   1 HACKING File for Evergreen
   2 ==========================
   3 :toc:
   4 :numbered:
   5
   6 Contributing
   7 ------------
   8 A
   9 http://evergreen-ils.org/dokuwiki/doku.php?id=contributing[tutorial for contributing to Evergreen is on the Evergreen Wiki].
  10
  11 Git
  12 ---
  13
  14 The
  15 http://evergreen-ils.org/dokuwiki/doku.php?id=dev:git[Git workflow used by the project is documented on the Evergreen Wiki].
  16
  17 Git Ignores
  18 ~~~~~~~~~~~
  19
  20 The +.gitignore+ file for the project level should only have files that
  21 are generated by the build or install processes of Evergreen itself.
  22
  23 Often, users of various text editors may want to ignore the backup or
  24 autosave files.  Evergreen recommends putting this not in the project's
  25 .gitignore, but into the global ignore files for their git configuration.
  26 Below is how to do this for various editors.
  27
  28 Creating A Global Git ignore file
  29 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  30 A useful tutorial on this issue can be found
  31 http://programblings.com/2008/10/22/git-global-ignores/[in this blog
  32 post].  The basic, command, however, is as follows:
  33
  34 [source,bash]
  35 ------------------------------------------------------------------------------
  36 git config --global core.excludesfile /path/to/my/global/gitignore
  37 ------------------------------------------------------------------------------
  38
  39 Many people like to use +~/.gitignore+ for +/path/to/my/global/gitignore+.
  40
  41 Git Ignore Emacs Autosave/backup files
  42 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  43 To ignore Emacs autosave/backup files, put the following lines in your
  44 +/path/to/my/global/gitignore+ file.
  45
  46 ------------------------------------------------------------------------------
  47 *~
  48 \#*#
  49 ------------------------------------------------------------------------------
  50
  51 Note the need of a backslash before the pound sign above, which is needed
  52 since pound usually is a comment in a +gitignore+ file.
  53
  54 Git Ignore Vim Autosave/backup files
  55 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  56
  57 To ignore vim autosave files, put the following lines in your
  58 +/path/to/my/global/gitignore+ file.
  59 ------------------------------------------------------------------------------
  60 *.swp
  61 ------------------------------------------------------------------------------
  62
  63 Note that vim sometimes creates more files of similar names, so you may want this:
  64
  65 ------------------------------------------------------------------------------
  66 *.s[vw][a-z]
  67 ------------------------------------------------------------------------------