Skip to content

Commit 8a38a41

Browse files
author
Andrew Pardoe
committed
Adding CONTRIBUTING.md and fixing up README.md, LICENSE
1 parent 701bf9b commit 8a38a41

File tree

3 files changed

+48
-6
lines changed

3 files changed

+48
-6
lines changed

CONTRIBUTING.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
## Contributing to the Guidelines Support Library
2+
3+
The Guidelines Support Library (GSL) contains functions and types that are suggested for use by the
4+
[C++ Core Guidelines](https://github.com/isocpp/CppCoreGuidelines). GSL design changes are made only as a result of modifications to the Guidelines.
5+
6+
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
7+
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
8+
a PR, please post a comment in the associated issue to avoid duplication of effort.
9+
10+
## Legal
11+
You will need to complete a Contributor License Agreement (CLA). Briefly, this agreement testifies that you are granting us and the community permission to
12+
use the submitted change according to the terms of the project's license, and that the work being submitted is under appropriate copyright.
13+
14+
Please submit a Contributor License Agreement (CLA) before submitting a pull request. You may visit https://cla.microsoft.com to sign digitally.
15+
16+
## Housekeeping
17+
Your pull request should:
18+
19+
* Include a description of what your change intends to do
20+
* Be a child commit of a reasonably recent commit in the **master** branch
21+
* Requests need not be a single commit, but should be a linear sequence of commits (i.e. no merge commits in your PR)
22+
* 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.
23+
* Have clear commit messages
24+
* e.g. "Fix issue", "Add tests for type", etc.
25+
* Include appropriate tests
26+
* Tests should include reasonable permutations of the target fix/change
27+
* Include baseline changes with your change
28+
* All changed code must have 100% code coverage
29+
* To avoid line ending issues, set `autocrlf = input` and `whitespace = cr-at-eol` in your git configuration

LICENSE

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,16 @@ Copyright (c) 2015 Microsoft Corporation. All rights reserved.
22

33
This code is licensed under the MIT License (MIT).
44

5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
9+
of the Software, and to permit persons to whom the Software is furnished to do
10+
so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
515
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
616
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
717
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,19 @@
11
# GSL: Guidelines Support Library
22

3-
This library contains functions and types that are suggested for use by the
4-
[C++ Coding Guidelines](https://github.com/Microsoft/CppCodingStandards/).
3+
The Guidelines Support Library (GSL) contains functions and types that are suggested for use by the
4+
[C++ Core Guidelines](https://github.com/isocpp/CppCoreGuidelines) maintained by the [Standard C++ Foundation](isocpp.org).
5+
This repo contains Microsoft's implementation of GSL, tracking Microsoft's fork of the Guidelines. Microsoft's fork can be found here:
6+
[C++ Core Guidelines](https://github.com/Microsoft/CppCoreGuidelines).
57

6-
These include types like `array_view<>`, `string_view<>`, `owner<>` and others.
8+
The library includes types like `array_view<>`, `string_view<>`, `owner<>` and others.
79

810
The entire implementation is provided inline in the headers under the [include](./include) directory.
911

1012
While some types have been broken out into their own headers (e.g. [include/array_view.h](./include/array_view.h)),
1113
it is simplest to just include [gsl.h](./include/gsl.h) and gain access to the entire library.
1214

13-
> NOTE: We encourage contributions that improve or refine any of the types in this library.
15+
> NOTE: We encourage contributions that improve or refine any of the types in this library as well as ports to
16+
other platforms. Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for more information about contributing.
1417

1518
# Quick Start
1619
## Supported Platforms
@@ -23,8 +26,8 @@ The test suite that exercises GSL has been built and passes successfully on the
2326
* Linux using Clang\LLVM 3.6
2427
* Linux using GCC 5.1
2528

26-
> If you successfully port GSL to another platform, we would love to hear from you. Please consider contributing
27-
any changes that were necessary back to this project to benefit the wider community.
29+
> 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
30+
contributing any changes that were necessary back to this project to benefit the wider community.
2831

2932
## Building the tests
3033
To build the tests, you will require the following:

0 commit comments

Comments
 (0)