Skip to content

DarwinJS/GitOpsforHumanProcessedChecklists

Repository files navigation

What is "Human Code"

This repository is based on a two part blog series that claims that Checklists are essentially "code for humans". If the GitOps principle of "A Single Source of Truth" is applied to this fact, then when human checklists play a fundamental role in the success of any software stack - they should be in Git.

Issue and Merge Request Templates

Since both GitLab and GitHub have special interactivity for markdown checkboxes when they are in Issues or Merge Requests (Pull Requests) and they have special ways to templatize these, this repository stores some checklist examples as templates for each of those system areas.

The merge request templates occasionally mention an issues template for an add on checklist. This allows linked checklists with interactivity that can be closed when the merge request closes.

In the case that a checklist involves merging merge requests it may be better to implement those as issues since continuing a checklist on a merge request after closure will not work. Merge requests could still have their own sub-checklist for things that must be done for merge success.

Article References

Part 1: Human-Processed Source Code Belongs in Git

GitOps for Human-Processed Code Part 2: Interactive Markdown Checklists on GitHub and GitLab

GitOps for Human-Processed Code Part 3: Desktop Tools for Markdown Checklists

More details about this repository

About

GitOps for Human Processed Checklists

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published