Skip to content

CONTRIBUTING step 4 reads as a hard precondition, and it has cost us two contributors' correct work #618

Description

@cevheri

CONTRIBUTING.md step 4 says "Run the local gate before pushing" and then prints a nine-command chain. Read as written, that is a precondition for opening a PR. It is not: the required CI checks are the authority, and a fork PR's checks run once a maintainer approves the workflow. Contributors whose environment cannot install bun (or helm, which the chart tests need - see #570) have no way to satisfy the sentence, and two of them have now withdrawn rather than submit work they could not verify.

Measured, twice.

So the wording is losing correct work, and the fork-approval step makes the only remaining verification path invisible to the contributor.

Fix, two parts.

  1. CONTRIBUTING.md, step 4: keep the command chain, and add that CI is the gate - a contributor who cannot run a step may say so in the PR body under a Testing heading, naming the commands they could not run, and a maintainer approves the workflow run. Mention npm install -g bun for sandboxes with npm registry access, and that helm is only needed for the unrelated chart tests. The same sentence belongs in the footer we paste onto curated Hacktoberfest issues (that footer is not stored in the repo today - putting it in a file under .github/ so it stops being retyped is welcome in the same PR).
  2. Add a .devcontainer/ with Bun and helm on PATH, so Codespaces and any devcontainer-aware editor give a contributor an environment where the chain in step 4 actually runs. bun install and helm dependency build charts/libredb-studio are the two setup steps worth wiring into postCreateCommand.

Done when step 4 no longer reads as a hard precondition, the CI-is-the-gate sentence exists in both places, .devcontainer/devcontainer.json opens a container where bun run typecheck and helm lint charts/libredb-studio --strict both succeed, and the container config is verified by an actual container start rather than by inspection. Docs plus config; no product code, and nothing here needs a new test beyond what the repo already guards.

Part 1 alone is a useful PR if part 2 is more than you want to take on - say so when you claim it and take just the docs half.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

documentationImprovements or additions to documentationhelp wantedExtra attention is needed

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions