Skip to content

docs: rewrite CONTRIBUTING.md, fix shellcheck warnings#52

Merged
stavxyz merged 2 commits into
mainfrom
docs/update-contributing-md
Jan 30, 2026
Merged

docs: rewrite CONTRIBUTING.md, fix shellcheck warnings#52
stavxyz merged 2 commits into
mainfrom
docs/update-contributing-md

Conversation

@stavxyz

@stavxyz stavxyz commented Jan 30, 2026

Copy link
Copy Markdown
Owner

Summary

  • Rewrite CONTRIBUTING.md from 224 lines to 78 lines, keeping only practical sections: Setup, Tests, PR Process, License
  • Simplify auth guidance to lead with gh auth login instead of manual PAT creation
  • Remove .envrc.example from the repo (no longer needed)
  • Fix all shellcheck warnings in unit tests (SC2076 quoted regex, SC2034 unused vars)

Test plan

  • just check passes (all 164 bats tests, shellcheck, ruff, mypy)
  • Review CONTRIBUTING.md reads well for new contributors

Drop Code Style, Project Structure, Getting Help, and Table of
Contents sections. Simplify auth guidance to lead with gh auth login.
Fix license reference from Unlicense to GPL-3.0.

Co-authored-by: stavxyz <hi@stav.xyz>
Unquote regex RHS in =~ comparisons (SC2076) and inline LOG_LEVEL
assignments with run commands (SC2034).

Co-authored-by: stavxyz <hi@stav.xyz>
@stavxyz stavxyz merged commit e373679 into main Jan 30, 2026
4 checks passed
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