Timothy Jones TimothyJones

## semver-from-git.sh
#!/bin/bash -eu

# This script prints out git metadata information for a given commit (or head by default)
# It assumes tags of the form `v1.2.3`, and will print prerelease versions when
# not on an exact tag.
#
# It is intended to be used like so:
#
#   cd <some-git-repo>
#   $(../semver-from-git.sh)

## handover-documentation-checklist.md

      
        
          
            
              
              1 file
            
          
          
            
              
              6 forks
            
          
          
            
              
              1 comment
            
          
          
            
              
              8 stars
            
          
        
        
          
              
          
          
            
                TimothyJones
                / handover-documentation-checklist.md
            
            
              Last active
              March 18, 2024 08:26
            
              
                Handover documentation checklist
              
          
        
      
        
  
      
    Handover documentation

Here's a list of things I find useful to check off when writing handover documentation for source code.
General sanity checks

These get checked at the end, but they're at the front of the document because they're good to keep in mind the whole time

 Do these instructions work cross-platform? If not, which platform do they work on?
 If the source of truth is not this document, should some of the questions be answered with links (to eg confluence/other repos)
	#!/bin/bash -eu

	# This script prints out git metadata information for a given commit (or head by default)
	# It assumes tags of the form `v1.2.3`, and will print prerelease versions when
	# not on an exact tag.
	#
	# It is intended to be used like so:
	#
	# cd <some-git-repo>
	# $(../semver-from-git.sh)