forked from microsoft/GSL
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adding CONTRIBUTING.md and fixing up README.md, LICENSE
- Loading branch information
Andrew Pardoe
committed
Aug 23, 2015
1 parent
701bf9b
commit 8a38a41
Showing
3 changed files
with
48 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters