Organize gitignore

.gitignore

@@ -4,72 +4,83 @@
 # or operating system, you probably want to add a global ignore instead:
 #   git config --global core.excludesfile ~/.gitignore_global
 
-# Ignore .swp files
+# Configuration ================================================================
-.*.swp
+# These files will differ from one user to another;
+# committing them may cause Zammad to behave unexpectedly on other machines
 
-# Ignore bundler config
+# Zammad -----------------------------------------------------------------------
-/.bundle
 
-# Ignore mac stuff
+# database (copy from config/database/database.yml, or use `rails bs:init`)
-.DS_Store
-
-# Ignore Rubymine config
-/.idea
-
-# Ignore .project files
-/.project
-
-# Ignore database config
 /config/database.yml
 
-# Ignore translation cache files
+# Third-Party ------------------------------------------------------------------
+# The config files / dev tools listed below are optional
+# and may not be present on most users' machines
+
+# Bundler
+/.bundle
+/Gemfile.local
+
+# Clutter ======================================================================
+# These files are automatically generated;
+# in most cases, committing them won't do anything other than bloat the repo
+
+# Zammad -----------------------------------------------------------------------
+
+# database files
+/db/*.sqlite3
+/db/schema.rb
+
+# translation cache files
 /config/locales*.yml
 /config/translations/*.yml
 
-# Ignore generated documentation
+# NPM / Yarn
-/doc
-
-# Ignore coverage stuff
-/coverage
-
-# Ignore the default SQLite database.
-/db/*.sqlite3
-
-# Ignore local changes to schema.rb (e. g. through extentions)
-/db/schema.rb
-
-# Ignore custom gem file
-/Gemfile.local
-
-# Ignore node modules
 /node_modules
 
-# Ignore all logfiles and tempfiles.
+# logfiles and tempfiles
 /log
 /public/assets/*.*
 /public/assets/app
 /public/assets/custom
 /public/assets/chat/node_modules
 /tmp/*
+!/tmp/pids
 /tmp/pids/*
+!/tmp/pids/.keep
 /storage/fs
 
-# except /tmp/pids/ which is needed for certain Zammad processes
+# doorkeeper (OAuth 2)
-!/tmp
-!/tmp/pids
-!/tmp/pids/.keep
-
-# ignore doorkeeper auto generated folder
 /public/assets/doorkeeper
 
-# ignore all automatically downloaded images except the default ones
+# images
 /public/assets/images/*
-!/public/assets/images/icons
+!/public/assets/images/icons/
 !/public/assets/images/avatar-bg.png
 !/public/assets/images/chat-demo-avatar.png
 !/public/assets/images/eyedropper.gif
 !/public/assets/images/icons.svg
 !/public/assets/images/logo.svg
 
-# ignore byebug history
+# Third-Party ------------------------------------------------------------------
+
+# macOS
+.DS_Store
+
+# vim
+.*.sw[pon]
+
+# RubyMine
+/.idea
+
+# Eclipse
+/.project
+
+# Byebug
 /.byebug_history
+
+# SimpleCov
+/coverage
+
+# RDoc / YARD
+/doc

Gemfile

@@ -171,4 +171,5 @@ end
 #               without having your changes overwritten during upgrades.)
 # ZAMMAD DEVS:  Consult the internal wiki
 #               (or else risk pushing unwanted changes to Gemfile.lock!)
+#               https://git.znuny.com/zammad/zammad/wikis/Tips#user-content-customizing-the-gemfile
 eval_gemfile 'Gemfile.local' if File.exist?('Gemfile.local')