Mirrors/awesome-hpp
1
0
Fork 0
mirror of https://github.com/p-ranav/awesome-hpp.git synced 2025-12-18 19:14:34 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md

Browse Source
This commit is contained in:
Pranav
2020-08-17 21:30:47 -05:00
committed by GitHub
parent 1bff459510
commit c0b63d97b4
1 changed files with 5 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
CONTRIBUTING.md
View File

@@ -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** `<XYZ> 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.