lbragaglia / common-practices Goto Github PK

Aka (Lightweight) Architectur(e|al) Decision Records (ADR)

• https://www.thoughtworks.com/radar/techniques/lightweight-architecture-decision-records
• https://adr.github.io/
• https://github.com/joelparkerhenderson/architecture_decision_record
• http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions
• https://github.com/npryce/adr-tools
• https://ssw.com.au/rules/document-discoveries
• https://www.infoq.com/news/2022/06/aws-adr-guide/
  https://docs.aws.amazon.com/prescriptive-guidance/latest/architectural-decision-records

Tuple’s Pair Programming Guide
On Pair Programming

How to define, measure, track and manage technical debt:

• Visualising and Prioritizing Technical Debt
• Dark Debt
• The Wall of Technical Debt
• A Tech Debt balance sheet

Collect here resources related to best practices, ground rules, way of working, etc.

• https://github.com/joelparkerhenderson/ground_rules
• https://github.com/joelparkerhenderson/ways_of_working
• https://github.com/joelparkerhenderson/statement_of_work
• https://github.com/LappleApple/awesome-leading-and-managing

Coding guidelines, from styles and formatting to programming principles and language idioms (there can be an overlapping with design principles and patterns).

• https://csharpcodingguidelines.com/
• https://www.sqlstyle.guide/
• https://www.red-gate.com/simple-talk/sql/t-sql-programming/basics-good-t-sql-coding-style/
• https://gist.github.com/mattmc3/38a85e6a4ca1093816c08d4815fbebfb
• google style guides:
  • https://google.github.io/styleguide/
  • https://google.github.io/styleguide/jsguide.html

Organization/team/workshop activities/techniques/tools to facilitate collaboration:

• SessionLab Library of facilitation techniques
• IAF (International Association of Facilitators) Methods database
• Free online workshop resources
• Teampedia is a collaborative encyclopedia of free team building activities, free icebreakers, teamwork resources, and tools for teams

• https://github.com/joho/awesome-code-review
• https://vladmihalcea.com/code-review-best-practices/
• https://medium.com/palantir/code-review-best-practices-19e02780015f
• https://phauer.com/2018/code-review-guidelines/
• https://www.kevinlondon.com/2015/05/05/code-review-best-practices.html
• https://medium.freecodecamp.org/code-review-the-ultimate-guide-aa45c358bbf5
• https://bitbucket.org/blog/5-pull-request-must-haves
• https://dev.to/uday_rayala/code-reviews-vs-pair-programming-560i
  https://dev.to/uday_rayala/code-review-checklist-20c6
• https://blog.jetbrains.com/upsource/category/practices/
• Getting the best out of your code reviews https://www.agilemovement.it/workingsoftware/schedule.html
• https://medium.com/@pegasquare_omar/the-code-review-process-6771e2ecd316
• https://speakerdeck.com/maltzj/code-reviewing-like-a-champion
• https://codeahoy.com/2016/04/03/effective-code-reviews/
• https://team-coder.com/code-reviews-in-trunk-based-development/
• https://medium.com/@johnbarton/code-review-review-is-the-managers-job-d412827a66c9
• https://chelseatroy.com/2019/12/18/reviewing-pull-requests/
• https://ketanbhatt.com/code-review/
• https://mtlynch.io/human-code-reviews-1/

tools:

• git guilt

other:

• https://medium.com/search?q=code%20review
• https://dev.to/search?q=code%20review

video:

• Code Review Matters and Manners: Maria Khalusova, Trisha Gee
• Code Review Best Practices
• Code Review Best Practices
• 10 Tips for Effective Code Review - Atlassian Summit 2016
• Code Reviews vs. Pull Requests - Atlassian Summit 2016

https://mobprogramming.org
I did mob programming every day for 5 months. Here’s what I learnt.
MOB PROGRAMMING: THE ROLE PLAYING GAME
https://github.com/dillonkearns/mobster
https://github.com/jahed/agility

Incident Post-Mortem (not the project post-mortem, see at the end) is a SRE retrospective.

• https://github.com/dastergon/postmortem-templates
• https://github.com/dastergon/awesome-sre#post-mortem
• https://github.com/LappleApple/awesome-leading-and-managing/blob/master/Postmortems-Retrospectives.md
• archives/examples:
  • https://github.com/danluu/post-mortems
• templates:
  • https://landing.google.com/sre/sre-book/chapters/postmortem/
  • https://gist.github.com/mlafeldt/6e02ea0caeebef1205b47f31c2647966
  • https://postmortems.pagerduty.com/resources/post_mortem_template/
  • https://www.atlassian.com/incident-management/postmortem/templates
  • https://app.tettra.co/teams/tettra/pages/incident-postmortem-template
  • https://lastbytes.wordpress.com/2013/01/15/a-postmortem-template/
  • https://gist.github.com/juliandunn/52b4fbde451628e0fe48
• tools:
  • https://github.com/etsy/morgue
• pagerduty:
  • https://thenewstack.io/how-pagerduty-developed-its-postmortem-best-practices/
  • https://thenewstack.io/pagerduty-open-sources-its-incident-response-best-practices/
  • https://www.pagerduty.com/resources/learn/post-mortem-incident-report/
  • https://postmortems.pagerduty.com/
  • https://response.pagerduty.com/after/post_mortem_process/
• google:
  • https://landing.google.com/sre/sre-book/chapters/postmortem-culture/
• atlassian:
  • https://www.atlassian.com/incident-management/postmortem
  • https://www.atlassian.com/incident-management/handbook/postmortems
• etsy:
  • https://codeascraft.com/2012/05/22/blameless-postmortems/
  • https://codeascraft.com/2016/11/17/debriefing-facilitation-guide/
  • https://github.com/etsy/DebriefingFacilitationGuide
• microsoft:
  • https://devblogs.microsoft.com/bharry/a-good-incident-postmortem/
• https://ebaytech.berlin/keeping-software-documentation-in-shape-49daeecacc60#d203
• https://increment.com/documentation/post-mortems-to-the-rescue/
• https://medium.com/@kwa29/it-post-mortem-guidelines-77214c6e7e34
• https://blog.demisto.com/the-top-seven-steps-for-conducting-a-post-mortem-following-a-security-incident
• https://alertops.com/five-steps-conduct-incident-post-mortem/
• https://tettra.co/article/how-to-do-an-incident-postmortem/
• https://digitalguardian.com/blog/learning-security-incident-post-mortem-checklist
• https://sharpend.io/writing-your-first-postmortem/
  https://sharpend.io/on-finding-root-causes/
• https://gracefuldisasters.com/post_mortem.html
• https://ebaytech.berlin/keeping-software-documentation-in-shape-49daeecacc60
• safeguarding:
  • http://llewellynfalco.blogspot.com/2018/12/safeguarding-step-by-step-guide.html
  • http://jay.bazuzi.com/Safeguarding/
  • http://arlobelshee.com/safeguarding-culture-is-a-process/
• video:
  • Postmortems and Retrospectives (class SRE implements DevOps)
  • Blameless Post Mortems
  • https://sysadmincasts.com/episodes/20-how-to-write-an-incident-report-postmortem
  • https://vimeo.com/77206751
• on project post-mortem:
  • https://www.zdnet.com/article/nine-steps-to-it-post-mortem-excellence/
  • https://en.wikipedia.org/wiki/Postmortem_documentation
• on project pre-mortem:
  • https://en.wikipedia.org/wiki/Pre-mortem
  • https://www.atlassian.com/team-playbook/plays/pre-mortem
  • https://sharpend.io/premortems-the-art-of-negative-visualization/
  • https://hbr.org/2007/09/performing-a-project-premortem

Aka branching model

• gitflow https://nvie.com/posts/a-successful-git-branching-model/
• oneflow https://www.endoflineblog.com/oneflow-a-git-branching-model-and-workflow
• github flow https://guides.github.com/introduction/flow/
• gitlab flow https://docs.gitlab.com/ee/workflow/gitlab_flow.html
• git workflow
  • https://hackernoon.com/how-the-creators-of-git-do-branches-e6fcc57270fb
  • https://git-scm.com/docs/gitworkflows#_managing_branches
  • https://github.com/rocketraman/gitworkflow
• trunk-based development https://trunkbaseddevelopment.com/

articles:

• http://scottchacon.com/2011/08/31/github-flow.html
• https://www.atlassian.com/git/tutorials/comparing-workflows
• https://www.atlassian.com/git/tutorials/merging-vs-rebasing
• https://www.atlassian.com/git/articles/git-team-workflows-merge-or-rebase
• https://www.atlassian.com/blog/inside-atlassian/inside-atlassian-feature-branching-on-the-stash-team
• https://www.atlassian.com/company/events/summit-us/watch-sessions/2013/archives/inside-the-development-team/git-workflows-a-la-carte
• https://robots.thoughtbot.com/git-interactive-rebase-squash-amend-rewriting-history
• https://www.themoderncoder.com/a-better-git-workflow-with-rebase/
• https://www.themoderncoder.com/combining-git-commits-with-squash/
• https://git-scm.com/book/en/v2/Git-Branching-Rebasing#_rebase_vs_merge
• https://medium.com/@fredrikmorken/why-you-should-stop-using-git-rebase-5552bee4fed1
• https://arm.ag/how-to-manage-git-workflow-and-stay-sane-e32405e9dbf0#.s7c8geewi
• https://sandofsky.com/blog/git-workflow.html
• https://medium.com/@porteneuve/getting-solid-at-git-rebase-vs-merge-4fa1a48c53aa
• http://guides.beanstalkapp.com/version-control/branching-best-practices.html
• https://www.youtube.com/watch?v=O4SoB3TFkjA
• https://news.ycombinator.com/item?id=9745966
• http://www.darwinweb.net/articles/the-case-for-git-rebase
• https://github.com/joelparkerhenderson/git_workflow_help
• https://blogs.technet.microsoft.com/devops/2016/06/21/a-git-workflow-for-continuous-delivery/
• https://www.atlassian.com/continuous-delivery/principles/workflows-with-feature-branching-and-gitflow
• http://wiki.bazaar.canonical.com/Workflows
• https://blog.scottlowe.org/2015/01/27/using-fork-branch-git-workflow/
• https://www.youtube.com/watch?v=PzEox3szeRc
• https://foojay.io/today/why-i-prefer-trunk-based-development/