Add common local commands section to CONTRIBUTING (Fixes #887)#1015
Open
kitcommerce wants to merge 1 commit intonextfrom
Open
Add common local commands section to CONTRIBUTING (Fixes #887)#1015kitcommerce wants to merge 1 commit intonextfrom
kitcommerce wants to merge 1 commit intonextfrom
Conversation
Adds a 'Common local commands' quick-reference section at the top of CONTRIBUTING.md covering the 5-10 commands contributors need day-to-day: - rbenv setup snippet (Ruby 3.2.7) - Docker services check + startup (script/check_service_ports, script/docker_services_status, script/services_up) - How to run a targeted engine test via script/test - How to run RuboCop (diff-only and full) - Boot smoke test via script/default_appraisal_boot_smoke Links out to Contribute Code on developer.workarea.com for full setup details rather than duplicating long explanations.
Contributor
Author
|
This PR is on hold — the linked issue has been flagged for owner review (churned 3+ times through the pipeline). A human will review whether to proceed or close this PR. |
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
Adds a 'Common local commands' quick-reference section to CONTRIBUTING.md.
The section covers the 5–10 commands contributors need day-to-day:
script/check_service_ports,script/docker_services_status,script/services_up)script/testscript/default_appraisal_boot_smokeLinks out to the canonical Contribute Code guide for full details rather than duplicating long explanations.
Client Impact
None (documentation only).
Verification Plan
Read the new section and confirm commands are accurate.