diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..aa15596 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,86 @@ +## Contributing to the C++ Core Guidelines + +>"Within C++ is a smaller, simpler, safer language struggling to get out." +>-- Bjarne Stroustrup + +The C++ Core Guidelines are a collaborative effort led by Bjarne Stroustrup, much like the C++ language itself. They are the result of many +person-years of discussion and design across a number of organizations. Their design encourages general applicability and broad adoption but +they can be freely copied and modified to meet your organization's needs. + +We encourage contributions to the C++ Core Guidelines in a number of ways: +- **Individual feedback** Are you a developer who is passionate about your code? Join the discussion in +[Issues](https://github.com/isocpp/CppCoreGuidelines/issues). We want to know which rules resonate with you and which don't. Were any rules +inordinately difficult to apply? Does your compiler vendor's Guideline Support Library (e.g., +[Microsoft's implementation of the GSL](https://github.com/microsoft/gsl)) suit your needs in adopting these guidelines? +- **Organizational adoption** While the guidelines are designed to be broadly adoptable they are also intended to be modified to fit your +organization's particular needs. We encourage your organization to fork this repo and create your own copy of these guidelines with changes +that reflect your needs. We suggest that you make it clear in the title of your guidelines that these are your organization's fork of the +guidelines and that you provide a link back to the original set of [guidelines](https://github.com/isocpp/CppCoreGuidelines). And if any of +your local changes are appropriate to pull back into the original guidelines, please open an +[Issue](https://github.com/isocpp/CppCoreGuidelines/issues) which can lead to a pull request. +- **Maintain the Guidelines** The C++ Core Guidelines were created from a wealth of knowledge spread across a number of organizations +worldwide. If you or your organization is passionate about helping to create the guidelines consider becoming an editor or maintainer. If +you're a C++ expert who is serious about participating please +[email coreguidelines@isocpp.org](mailto:coreguidelines@isocpp.org?subject=Maintain the C++ Code Guidelines). + +## Contributor License Agreement +By contributing content to the C++ Core Guidelines (i.e., submitting a pull request for inclusion in this repository) you agree with the +[Standard C++ Foundation](https://isocpp.org/about) [Terms of Use](https://isocpp.org/home/terms-of-use), especially all of the terms specified +regarding Copyright and Patents. +- You warrant that your material is original, or you have the right to contribute it. +- With respect to the material that you own, you grant a worldwide non-exclusive irrevocable transferable royalty-free license to your contributed +material to Standard C++ Foundation to display, reproduce, perform, distribute and create derivative works of that material for commercial or +non-commercial use. With respect to any other material you contribute, such material must be under a license sufficient to allow Standard C++ Foundation +to display, reproduce, perform, distribute and create derivative works of that material for commercial or non-commercial use. +- You agree that, if your contributed material is subsequently reflected in the ISO/IEC C++ standard in any form, it will be subject to all ISO/IEC JTC +1 policies including [copyrights](http://www.iso.org/iso/home/policies.htm), +[patents](http://www.iso.org/iso/home/standards_development/governance_of_technical_work/patents.htm), and +[procedures](http://www.itscj.ipsj.or.jp/sc29/29w7proc.htm); please direct any questions about these policies to the +[ISO Central Secretariat](http://www.iso.org/iso/home/about.htm). + + +## Pull requests + +We welcome pull requests for scoped changes to the guidelines--bug fixes in +examples, clarifying ambiguous text, etc. Significant changes should first be +discussed in the [Issues](https://github.com/isocpp/CppCoreGuidelines/issues) +and the Issue number must be included in the pull request. For +guideline-related changes, please specify the rule number in your Issue and/or +Pull Request. + +Changes should be made in a child commit of a recent commit in the master +branch. If you are making many small changes, please create separate PRs to +minimize merge issues. + +### Document Style Guidelines + +Documents in this repository are written in an unspecific flavor of Markdown, +which leaves some ambiguity for formatting text. We ask that pull requests +maintain the following style guidelines, though we are aware that the document +may not already be consistent. + +#### Indentation + +Code and nested text should use multiples of 4 spaces of indentation, and no +tab characters, like so: + + void func(const int x) + { + std::cout << x << '\n'; + } + +#### Code Blocks + +Please use 4-space indentation to trigger code parsing, rather than [fenced code blocks](https://help.github.com/articles/github-flavored-markdown/#fenced-code-blocks) or any other style, like so: + + This is some document text, with an example below: + + void func() + { + std::cout << "This is code.\n"; + } + +### Miscellaneous + +To avoid line-ending issues, please set `autocrlf = input` and `whitespace = +cr-at-eol` in your git configuration. diff --git a/_includes/sidebar.html b/_includes/sidebar.html index 3ddd1f5..e7be456 100644 --- a/_includes/sidebar.html +++ b/_includes/sidebar.html @@ -19,9 +19,10 @@ F: Functions C: Classes and class hierarchies Enum: Enumerations + R: Resource management ES: Expressions and statements E: Error handling - R: Resource management + Con: Constants and immutability T: Templates and generic programming CP: Concurrency STL: The Standard library @@ -29,7 +30,8 @@ CPL: C-style programming PRO: Profiles GSL: Guideline support library - + FAQ: Answers to frequently asked questions + NL: Naming and layout PER: Performance N: Non-Rules and myths @@ -37,12 +39,13 @@ Appendix A: Libraries Appendix B: Modernizing code Appendix C: Discussion + Appendix C: Glossary To-do: Unclassified proto-rules {% else %} - The actual Guidelines + C++ Core Guidelines README Contributing License diff --git a/index.html b/index.html index 415f964..8ce489f 100644 --- a/index.html +++ b/index.html @@ -2,16 +2,19 @@ layout: default --- -

This site is clone of the C++ Core Guidelines demonstrating the possible use of github pages. The source files from the master branch are not changed (with the exception of 3 lines added at the top). This site shows how stylesheets, a sidebar and syntax highlighting could be added for better readability (button at bottom of sidebar). Prettier fonts can be used (than github default), and the code-blocks have been adapted not to wrap long lines on large screens. +

This site is copy of the C++ Core Guidelines rendered for easier browsing. As the text on this page is integrated manually + you should refer to the C++ Core Guidelines repo for the most up-to-date version.

+