From c0b63d97b42559f45b2b90b7733ed58d28cf68df Mon Sep 17 00:00:00 2001 From: Pranav Date: Mon, 17 Aug 2020 21:30:47 -0500 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5a75e0c..b7b9dd5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,8 +3,12 @@ Please ensure your pull request adheres to the following guidelines: * Please search previous suggestions before making a new one, as yours may be a duplicate. * Please make an individual pull request for each suggestion. -* Use the following format: \[RESOURCE\]\(REPO-LINK\) - DESCRIPTION. * Keep descriptions short and simple. + - There is very limited space in the README tables for descriptions. So, try to keep descriptions to 1 line in the rendered table + - No need to say "header-only" - every library in the README is header-only + - Examples: + - **THIS IS TOO LONG** ` is a lightweight header only library for doing X and Y in Z in C++17 (and later!)` + - **THIS IS BETTER** `X and Y in Z in >=C++17` * End all descriptions with a full stop/period. * Make sure your text editor is set to remove trailing whitespace. * Order projects alphabetically within each category.