Shopify / Shopify/ruby-style-guide
Include reasoning in some rules
Open
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 634
- Forks
- 49
- Avg merge
- 8d 2h
- Merged PRs (30d)
- 4
Description
Extracted from #74. It’s not clear however which rules require the « why » to be explicit in the style guide. I fear that explaining the whole context behind a rule would make the document way too long, and developers can access the PR discussions to learn more about it via git blame.
cc @sambostock
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with issue #74 and the existing Ruby style guide; identify which rules lack rationale and review related pull request discussions through git blame. Done means the guide has an agreed, focused set of explanations without expanding into the full context behind every rule.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100