Skip to content

docs: testing.md does not instruct contributors to clone base-bash-libs first #951

@codeforester

Description

@codeforester

The "Bash Command And Runtime Tests" section explains that Base expects a sibling ~/work/base-bash-libs directory but gives no clone instruction. A first-time contributor following this doc will run env -u BASE_HOME ./bin/base-test and see a cryptic bootstrap failure. The section says "a normal ~/work/base checkout uses sibling ~/work/base-bash-libs automatically" but treats the existence of that checkout as assumed rather than as a prerequisite to establish.

Fix: Add a callout box or numbered prereq step at the top of the BATS section with the exact command:

git clone https://github.com/basefoundry/base-bash-libs.git ~/work/base-bash-libs

Note that BASE_BASH_LIBS_DIR can override this for nonstandard worktree layouts.

File: docs/testing.md

Metadata

Metadata

Assignees

Labels

documentationDocumentation improvements

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions