isocpp / isocpp/CppCoreGuidelines

Give a split view of the Guidelines when vied on a phone by chapters.

Open
#923 22 comments 7 reactions 1 assignee View on GitHub

@jwakely is already working on this.

Since May 22, 2017.

Dominant language
CSS
Stars
45.3k
Forks
5.6k
PR merge metrics
No merged PRs in 30d

Description

I would like each and every entry have separate files for the following reasons:

  • cannot view the guidelines in phone based devices without the phone we freezing for a long time making the phone battery to get drained and wasted considerably. Some people like me read the guidelines when they are not on an actual desktop or laptop computer.
  • Makes editing everything a lot easier and faster without scrolling through thousands of millions of lines just to find the right place to make changes. This makes patches to things a lot faster.

Yes, I know the drawback of this is maybe hundreds or thousands of markdown file but each guideline markdown file would be the name that is selected for them for example c. 140 would be 'c140.md'.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.