From 4f508fc6261432e652fd7924e14a20537d31a5f1 Mon Sep 17 00:00:00 2001 From: Anthony Calandra Date: Thu, 13 Jun 2019 22:03:00 -0400 Subject: [PATCH] Update CONTRIBUTING doc with cheatsheet goals. --- CONTRIBUTING.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2fbbc41..87dd3ed 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,3 +12,7 @@ example of its usage. An optimal submission would also include a short real-worl * Make sure the feature is in the correct C++ version. * Make sure you've added the feature to the table of contents. * Make sure you have also added the feature to the separate major C++ readme files (ie. CPP11.md, CPP14.md, etc.). +* Keep additions/deletions of content consistent with the cheatsheet's goals. + +## Goals +My goal for this cheatsheet is to prefer conciseness over absolute completeness. Examples of features should be minimal: if an example is overly complicated, large, or is more of an obscure usage of the feature then it will most likely be rejected in review. The reason for this goal is to teach users what the most popular uses of these features will be, and for a more thorough investigation, to learn about those from external C++ resources.