Add CONTRIBUTING.md and trim README#278
Draft
yahonda wants to merge 2 commits intorsim:masterfrom
Draft
Conversation
Document how to report issues, submit PRs, work in the devcontainer, run the spec suite (including seed-based reproduction and bisect), and run RuboCop with the same commands as CI. Modelled after rsim/oracle-enhanced to keep contributor guidance consistent across the two adapters.
Migrate the manual database setup, dependency install, and test invocation steps from README's TESTS section into CONTRIBUTING.md (under a new "Manual setup (without devcontainer)" section) and replace the README section with a pointer. The README's hand-maintained CONTRIBUTORS list is replaced with a thank-you note plus a link to github.com/rsim/ruby-plsql/graphs/contributors so the canonical list lives on GitHub instead of drifting in the repo.
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.mdmodelled on rsim/oracle-enhanced: how to report issues, submit PRs, develop in the devcontainer (added in Add devcontainer environment and CI #276), reproduce randomized spec runs by seed (with--bisect), and run RuboCop with the same commands as CI.bundle install,rake spec) into a new "Manual setup (without devcontainer)" section inCONTRIBUTING.md, and replace the README section with a one-line pointer.Notes
README.mdnear the same area as Update README Ruby and Oracle versions to match CI #277 (README Ruby/Oracle version refresh). If Update README Ruby and Oracle versions to match CI #277 merges first, this branch will need a small rebase.Test plan
CONTRIBUTING.mdandREADME.mdon GitHub read naturally.CONTRIBUTING.mdlink from README resolves once the PR is merged.🤖 Generated with Claude Code