Skip to content

CONTRIBUTING: the bash rules learned today - #25

Merged
flyingrobots merged 1 commit into
mainfrom
docs/contributing-bash-rules
Sep 16, 2026
Merged

flyingrobots merged 1 commit into
mainfrom
docs/contributing-bash-rules

Conversation

@flyingrobots

Copy link
Copy Markdown
Member

Subshells and memoisation, printf -v shadowing, snapshot loading, install-as-copy, process counts as tests. Docs only; no release.

@coderabbitai

coderabbitai Bot commented Sep 16, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 690e7b6f-1d06-48e5-9081-477ef2b013b2

📥 Commits

Reviewing files that changed from the base of the PR and between db808fc and 36cfb7a.

📒 Files selected for processing (1)
  • CONTRIBUTING.md

📝 Summary

Summary by CodeRabbit

  • Documentation
    • Expanded contribution guidance with practical Bash scripting lessons, including subshell behavior, caller-variable updates, helper usage, and state invalidation.
    • Added guidance for loading store state before command dispatch and keeping tool installations separate from editable checkouts.
    • Documented testing practices that limit Git process usage while preserving protocol coverage.

Walkthrough

CONTRIBUTING.md adds five Bash-specific rules. The rules cover subshell state, caller-variable helpers, store snapshots, installation, and git process counting in tests.

Changes

Bash Rules Documentation

Layer / File(s) Summary
Document Bash rules
CONTRIBUTING.md
Adds guidance for Bash subshell behavior, printf -v helper conventions, store snapshot invalidation, installation by copy, and counting git spawns in tests.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

A rabbit reads the Bash rules bright
Subshells keep their state out of sight
Helpers write where callers say
Snapshots refresh after each play
Git spawns count along the way
And copied tools keep links at bay

Comment @coderabbitai help to get the list of available commands.

@flyingrobots
flyingrobots merged commit f0b4c26 into main Sep 16, 2026
2 of 3 checks passed
@flyingrobots
flyingrobots deleted the docs/contributing-bash-rules branch September 16, 2026 03:41
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