Update CONTRIBUTING setup and test commands to match current README - #2872
Open
artfuldev wants to merge 1 commit into
Open
Update CONTRIBUTING setup and test commands to match current README#2872artfuldev wants to merge 1 commit into
artfuldev wants to merge 1 commit into
Conversation
artfuldev
marked this pull request as ready for review
September 12, 2026 16:01
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
CONTRIBUTING.md's setup and test/lint commands are inconsistent with what the rest of the repo (README, Makefile, AGENTS.md) actually documents and uses today.
Why did we do this?
Verified each command directly against this repo before changing anything:
rake db:create db:migrate db:seedand barerails serverstill work once the native toolchain (mise, PostgreSQL, ImageMagick) is installed — but CONTRIBUTING.md never mentions installing that toolchain at all, unlike the README's own "Quick start", which walks through it. A contributor following only this file would hitpggem compile errors with no explanation of why.rakedoes still run the full RSpec suite (confirmed locally) — but serially, with no way to target files, and it's not what the project's own Makefile/README/AGENTS.md document or use (bundle exec rspec,bundle exec parallel_rspec).rubocophappened to work in this session's environment because gems ended up resolvable outside Bundler — not something to rely on across different Ruby version managers.bundle exec rubocopis what the rest of the repo's docs consistently use.None of these commands were actually broken; they were just out of step with the setup this repo has already standardized on elsewhere, which risks confusing a new contributor who reads this file expecting it to be the current source of truth.
Will this break anything?
No, this only touches documentation.
How was this tested?
Ran the corrected commands directly in this repo — real recorded terminal sessions (animated):
bundle exec rubocop:bundle exec rspec(shown against one fast spec file for a readable capture; the full suite was also run and passes aside from pre-existing, unrelated local-environment gaps):For setup, pointed at the README's own "Quick start" section instead of duplicating it here, so the two docs can't independently drift out of sync again.