Skip to content

Add CONTRIBUTING, CHANGELOG and issue templates - #17

Merged
saeed205 merged 1 commit into
mainfrom
contributing-and-changelog
Aug 19, 2026
Merged

saeed205 merged 1 commit into
mainfrom
contributing-and-changelog

Conversation

@saeed205

Copy link
Copy Markdown
Owner

Writes down the conventions that so far only existed as a pattern in the code.

CONTRIBUTING.md documents the five steps to add a command, and the four house rules that are not obvious from reading a single module:

  • standard library only - a diagnostics tool you cannot install on a locked-down jump box is not much use
  • 3.9 is the floor, and the typing-module spellings are deliberate (points at the ruff.toml comment before anyone "modernises" them)
  • exit status is an interface - people put these in monitoring checks, so a failed probe must not return 0
  • helpers never print; rendering stays in output.py so --json keeps working everywhere for free

The testing section states the constraint directly: anything that opens a socket does not belong in the suite, because CI runs on sandboxed runners with no egress.

CHANGELOG.md in Keep a Changelog format, with 0.1.0 covering the six commands.

Issue templates ask for the diagnostic question rather than the requested flag, and the bug template asks for the correct value and a reference - for a wrong-answer bug in subnet math, that is the whole report.

@saeed205
saeed205 merged commit 35b0e08 into main Aug 19, 2026
7 checks passed
@saeed205
saeed205 deleted the contributing-and-changelog branch August 19, 2026 16:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant