johnandersen777.bsky.social/knotless

Switch repository

Loading…

Templates: a maintainer asks pulls and issues to follow templates, and a contributor and a user who have not been told of them open one of each.

alice

You keep a small shell utility, tidy. Create the repository and commit to main: tidy.sh, a script that deletes *.tmp files under the directory it is given, and README.md, a few lines saying what it does. Then commit .knotless/pull.md, exactly these lines without their four-space indent:

<!-- Title: what the change does, in the present tense and under 60
     characters, e.g. "Skips hidden directories". No "fix:" prefixes. -->

## What changes

## Why

## How it was checked

and .knotless/issue.md, the same way:

<!-- Title: the symptom, not the cure, e.g. "Deletes files outside the
     directory given". -->

## What happened

## What you expected

## How to see it

bob

You use {alice}'s tidy, and want it to take a -n flag that prints what it would delete instead of deleting it. You cannot push to their repository. Make the change in your own copy, on a branch, and open a pull into main asking {alice} to take it.

carol

You ran {alice}'s tidy on a big build directory and it finished without a word, so you could not tell whether it deleted anything. Tell {alice} about it in an issue on tidy. Do not change the script.

alice

Look at the pull and the issue opened on tidy today. For each, say whether its title and body follow the templates in .knotless/, quoting the title, and what, if anything, is missing. Comment on each with what you found.