Include reasoning in some rules
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- ruby
- Domain
- documentation
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.
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
- Dominant language
- Ruby
- Stars
- 634
- Forks
- 49
- Avg merge
- 8d 2h
- Merged PRs (30d)
- 4
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.
Similar issues
-
user-reported
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Kong/developer.konghq.com#7316 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
TheOdinProject/curriculum#31408 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
bensheldon/good_job#1816 · 5 comments ·
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
notch8/utk_knapsack#148 ·