gitRegeln.txt 2.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. Git Regeln:
  2. - Keine grossen Videos (avi / mp4 / wmv / ...)
  3. - Keine grossen Bilder (jpg / png / tiff / bmp / xcf / ppt / pptx)
  4. - Keine grossen Ton-Dateien (wav / mp3 / flac / ...)
  5. - Keine grossen Programme / Installer (exe / msi / o / jar)
  6. - Keine grossen Binaerdateien (bin / dat / zip / gz / bz)
  7. - Keine grossen Dateien, die sich aus den bereits vorhandenen Quelltexten herstellen lassen.
  8. - Keine grossen zwischen Dateien (o / class)
  9. Als gross gelten alle Dateien > 1MB
  10. Repositories sollten mit History < 200Mb bleiben, ab 500MB wird gemahnt.
  11. == [https://medium.com/free-code-camp/follow-these-simple-rules-and-youll-become-a-git-and-github-master-e1045057468f] ==
  12. Rule #1: Create a Git repository for every new project
  13. Rule #2: Create a new branch for every new feature
  14. Rule #3: Use Pull Requests to merge code to Master
  15. * https://guides.github.com/introduction/flow/
  16. * https://hackmd.io/@thomasburleson/BJrUV8ssr
  17. * https://github.com/k88hudson/git-flight-rules
  18. * https://chris.beams.io/posts/git-commit/
  19. * https://zellwk.com/blog/what-not-to-save-into-a-git-repo/
  20. * Files that don’t belong to the project (.DS_Store, Thumds.db, .vscode)
  21. * Files that are automatically generated
  22. * Libraries (if managed by package manager)
  23. * Credentials (username, password, API-Keys)
  24. * https://medium.com/@w3docs/7-things-you-shouldnt-do-in-git-4d0ea10bc999
  25. * https://faun.pub/5-file-types-you-should-and-10-you-should-not-store-in-your-vcs-d03c99f37930
  26. + source code files such as .java, .sql, .js, .html, .css
  27. + build tool configuration files such as mvn.xml, build.gradle, package.json
  28. + DevOps tools configuration such as Dockerfile, Jenkinsfile, Vagrantfile,
  29. + infrastructure code required to install and run your software such as: Bash, Ansible, Terraform scripts
  30. + other text formatted documents such as README, LICENSE and documents written in markup languages
  31. - dependencies → those dependencies should be resolved through build tools like mvn, gradle, npm
  32. - dependency caches, such as the contents of /node_modules or /packages
  33. - compiled code, such as .o, .pyc, and .class files
  34. - build output directories, such as /bin, /out, or /target
  35. - files generated at runtime, such as .log, .lock, or .tmp
  36. - files generated during build process → this avoid situation that someone will try modify generated file
  37. - hidden system files, such as .DS_Store or Thumbs.db
  38. - personal IDE config files, such as .idea/workspace.xml
  39. - non text based documentation as .pdf, .docx, .xlsx, .pptx→ it’s better to use some wiki software or specialized products like Google Docs or Microsoft Office 365
  40. - sensitive information
  41. * https://stackoverflow.com/questions/1911005/git-and-binary-data
  42. * https://www.perforce.com/blog/vcs/how-git-lfs-works
  43. * https://www.perforce.com/blog/vcs/how-choose-right-git-powered-wiki-your-team
  44. * https://stevebennett.me/2012/02/24/10-things-i-hate-about-git/
  45. * https://svenpet.com/2013/02/21/dont-use-git/