isocpp / isocpp/CppCoreGuidelines
Move the proto-rules out of the document
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 45.3k
- Forks
- 5.6k
- PR merge metrics
- No merged PRs in 30d
Description
The "unclassified proto-rules" has a lot of text which isn't rules. Some of it are propositions, but some are comments, questions, or bits of exchanges.
That should not be in the document - this repository has an issues section which is the appropriate place for those "rules", possibly with an issue tag of their own.
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 by locating the “unclassified proto-rules” section in the repository’s documentation and review which passages are rules versus propositions, comments, questions, or exchanges. Check the repository’s issues section and its tagging conventions before deciding how the non-rule material should be moved; done means the document contains only appropriate rules and the displaced material has a suitable issue location.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100