Skip to content

docs: CONTRIBUTING.md omits base-bash-libs sibling checkout requirement #950

@codeforester

Description

@codeforester

The contributor setup section instructs new contributors to run basectl setup --profile dev and then env -u BASE_HOME ./bin/base-test, but never mentions that the full test suite requires a sibling base-bash-libs checkout at ~/work/base-bash-libs. Without it, Base cannot resolve BASE_BASH_LIBS_DIR at runtime bootstrap, so every BATS test fails. The testing.md doc mentions this in passing, but CONTRIBUTING.md is the authoritative contributor onboarding path.

Fix: Add an explicit step before basectl setup --profile dev:

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

with one sentence explaining that Base resolves reusable Bash libraries from a sibling checkout during source development.

File: CONTRIBUTING.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