Improve contributing documentation#1014
Open
mattmenefee wants to merge 2 commits intotoptal:masterfrom
Open
Conversation
Both README.md and CONTRIBUTING.md told contributors to run tests and RuboCop but never explained how, and the README only mentioned the native Rake-based Elasticsearch setup — not the Docker Compose workflow that CI actually uses. This created unnecessary friction for new contributors. - Add a "Development setup" section to CONTRIBUTING.md covering prerequisites, Elasticsearch (Docker Compose + native Rake), ES_HOST/ES_PORT env vars, running tests, RuboCop, and multi-Rails gemfile testing - Replace the Rake task block in README.md with a link to CONTRIBUTING.md for full setup details
The fork/branch/commit/push/PR steps were duplicated between both files. Consolidate them into CONTRIBUTING.md as the single source of truth and reduce the README section to a link. - Move the step-by-step contribution workflow into the "Pull requests" section of CONTRIBUTING.md - Replace the gun.io guide link with opensource.guide — the gun.io article is a blog post on a freelancing platform that has gone through several pivots and could disappear at any time, while opensource.guide is a GitHub-maintained, open-source, actively maintained community resource - Add `bundle exec` prefix to Rake elasticsearch commands
mattmenefee
force-pushed
the
update-contributing-docs
branch
from
626ba06 to
ee89269
Compare
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
1 participant
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.
Summary
CONTRIBUTING.mdcovering prerequisites, Elasticsearch (Docker Compose + native Rake), running tests, RuboCop, and multi-Rails gemfile testingREADME.mdintoCONTRIBUTING.mdas the single source of truthCONTRIBUTING.mdTest plan
CONTRIBUTING.mdlink in README resolves correctly