mirror of
https://github.com/microsoft/GSL.git
synced 2024-11-25 01:01:58 -05:00
Adding CONTRIBUTING.md and fixing up README.md, LICENSE
This commit is contained in:
parent
701bf9b268
commit
8a38a411ca
29
CONTRIBUTING.md
Normal file
29
CONTRIBUTING.md
Normal file
@ -0,0 +1,29 @@
|
|||||||
|
## Contributing to the Guidelines Support Library
|
||||||
|
|
||||||
|
The Guidelines Support Library (GSL) contains functions and types that are suggested for use by the
|
||||||
|
[C++ Core Guidelines](https://github.com/isocpp/CppCoreGuidelines). GSL design changes are made only as a result of modifications to the Guidelines.
|
||||||
|
|
||||||
|
GSL is accepting contributions that improve or refine any of the types in this library as well as ports to other platforms. Changes should have an issue
|
||||||
|
tracking the suggestion that has been approved the maintainers. Your pull request should include a link to the bug that you are fixing. If you've submitted
|
||||||
|
a PR, please post a comment in the associated issue to avoid duplication of effort.
|
||||||
|
|
||||||
|
## Legal
|
||||||
|
You will need to complete a Contributor License Agreement (CLA). Briefly, this agreement testifies that you are granting us and the community permission to
|
||||||
|
use the submitted change according to the terms of the project's license, and that the work being submitted is under appropriate copyright.
|
||||||
|
|
||||||
|
Please submit a Contributor License Agreement (CLA) before submitting a pull request. You may visit https://cla.microsoft.com to sign digitally.
|
||||||
|
|
||||||
|
## Housekeeping
|
||||||
|
Your pull request should:
|
||||||
|
|
||||||
|
* Include a description of what your change intends to do
|
||||||
|
* Be a child commit of a reasonably recent commit in the **master** branch
|
||||||
|
* Requests need not be a single commit, but should be a linear sequence of commits (i.e. no merge commits in your PR)
|
||||||
|
* It is desirable, but not necessary, for the tests to pass at each commit. Please see [README.md](./README.md) for instructions to build the test suite.
|
||||||
|
* Have clear commit messages
|
||||||
|
* e.g. "Fix issue", "Add tests for type", etc.
|
||||||
|
* Include appropriate tests
|
||||||
|
* Tests should include reasonable permutations of the target fix/change
|
||||||
|
* Include baseline changes with your change
|
||||||
|
* All changed code must have 100% code coverage
|
||||||
|
* To avoid line ending issues, set `autocrlf = input` and `whitespace = cr-at-eol` in your git configuration
|
10
LICENSE
10
LICENSE
@ -2,6 +2,16 @@ Copyright (c) 2015 Microsoft Corporation. All rights reserved.
|
|||||||
|
|
||||||
This code is licensed under the MIT License (MIT).
|
This code is licensed under the MIT License (MIT).
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
|
||||||
|
of the Software, and to permit persons to whom the Software is furnished to do
|
||||||
|
so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
15
README.md
15
README.md
@ -1,16 +1,19 @@
|
|||||||
# GSL: Guidelines Support Library
|
# GSL: Guidelines Support Library
|
||||||
|
|
||||||
This library contains functions and types that are suggested for use by the
|
The Guidelines Support Library (GSL) contains functions and types that are suggested for use by the
|
||||||
[C++ Coding Guidelines](https://github.com/Microsoft/CppCodingStandards/).
|
[C++ Core Guidelines](https://github.com/isocpp/CppCoreGuidelines) maintained by the [Standard C++ Foundation](isocpp.org).
|
||||||
|
This repo contains Microsoft's implementation of GSL, tracking Microsoft's fork of the Guidelines. Microsoft's fork can be found here:
|
||||||
|
[C++ Core Guidelines](https://github.com/Microsoft/CppCoreGuidelines).
|
||||||
|
|
||||||
These include types like `array_view<>`, `string_view<>`, `owner<>` and others.
|
The library includes types like `array_view<>`, `string_view<>`, `owner<>` and others.
|
||||||
|
|
||||||
The entire implementation is provided inline in the headers under the [include](./include) directory.
|
The entire implementation is provided inline in the headers under the [include](./include) directory.
|
||||||
|
|
||||||
While some types have been broken out into their own headers (e.g. [include/array_view.h](./include/array_view.h)),
|
While some types have been broken out into their own headers (e.g. [include/array_view.h](./include/array_view.h)),
|
||||||
it is simplest to just include [gsl.h](./include/gsl.h) and gain access to the entire library.
|
it is simplest to just include [gsl.h](./include/gsl.h) and gain access to the entire library.
|
||||||
|
|
||||||
> NOTE: We encourage contributions that improve or refine any of the types in this library.
|
> NOTE: We encourage contributions that improve or refine any of the types in this library as well as ports to
|
||||||
|
other platforms. Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for more information about contributing.
|
||||||
|
|
||||||
# Quick Start
|
# Quick Start
|
||||||
## Supported Platforms
|
## Supported Platforms
|
||||||
@ -23,8 +26,8 @@ The test suite that exercises GSL has been built and passes successfully on the
|
|||||||
* Linux using Clang\LLVM 3.6
|
* Linux using Clang\LLVM 3.6
|
||||||
* Linux using GCC 5.1
|
* Linux using GCC 5.1
|
||||||
|
|
||||||
> If you successfully port GSL to another platform, we would love to hear from you. Please consider contributing
|
> If you successfully port GSL to another platform, we would love to hear from you. Please submit an issue to let us know. Also please consider
|
||||||
any changes that were necessary back to this project to benefit the wider community.
|
contributing any changes that were necessary back to this project to benefit the wider community.
|
||||||
|
|
||||||
## Building the tests
|
## Building the tests
|
||||||
To build the tests, you will require the following:
|
To build the tests, you will require the following:
|
||||||
|
Loading…
Reference in New Issue
Block a user