json/.github/PULL_REQUEST_TEMPLATE.md

[Describe your pull request here. Please read the text below the line, and make sure you follow the checklist.]

* * *

## Pull request checklist

Read the [Contribution Guidelines](https://github.com/nlohmann/json/blob/develop/.github/CONTRIBUTING.md) for detailed information.

- [ ]  Changes are described in the pull request, or an [existing issue is referenced](https://github.com/nlohmann/json/issues).
- [ ]  The test suite [compiles and runs](https://github.com/nlohmann/json/blob/develop/README.md#execute-unit-tests) without error.
- [ ]  [Code coverage](https://coveralls.io/github/nlohmann/json) is 100%. Test cases can be added by editing the [test suite](https://github.com/nlohmann/json/tree/develop/test/src).
- [ ]  The source code is amalgamated; that is, after making changes to the sources in the `include/nlohmann` directory, run `make amalgamate` to create the single-header file `single_include/nlohmann/json.hpp`. The whole process is described [here](https://github.com/nlohmann/json/blob/develop/.github/CONTRIBUTING.md#files-to-change).

## Please don't

- The C++11 support varies between different **compilers** and versions. Please note the [list of supported compilers](https://github.com/nlohmann/json/blob/master/README.md#supported-compilers). Some compilers like GCC 4.7 (and earlier), Clang 3.3 (and earlier), or Microsoft Visual Studio 13.0 and earlier are known not to work due to missing or incomplete C++11 support. Please refrain from proposing changes that work around these compiler's limitations with `#ifdef`s or other means.
- Specifically, I am aware of compilation problems with **Microsoft Visual Studio** (there even is an [issue label](https://github.com/nlohmann/json/issues?utf8=✓&q=label%3A%22visual+studio%22+) for these kind of bugs). I understand that even in 2016, complete C++11 support isn't there yet. But please also understand that I do not want to drop features or uglify the code just to make Microsoft's sub-standard compiler happy. The past has shown that there are ways to express the functionality such that the code compiles with the most recent MSVC - unfortunately, this is not the main objective of the project.
- Please refrain from proposing changes that would **break [JSON](https://json.org) conformance**. If you propose a conformant extension of JSON to be supported by the library, please motivate this extension.
- Please do not open pull requests that address **multiple issues**.
:memo: overworked templates 2017-10-29 16:32:23 +01:00			`[Describe your pull request here. Please read the text below the line, and make sure you follow the checklist.]`
Create PULL_REQUEST_TEMPLATE.md 2016-02-20 23:22:46 +01:00
:memo: overworked templates 2017-10-29 16:32:23 +01:00			`* * *`
Create PULL_REQUEST_TEMPLATE.md 2016-02-20 23:22:46 +01:00
:memo: overworked templates 2017-10-29 16:32:23 +01:00			`## Pull request checklist`
Create PULL_REQUEST_TEMPLATE.md 2016-02-20 23:22:46 +01:00
:memo: overworked documentation wrt. amalgamation #906 2018-01-14 13:08:28 +01:00			`Read the [Contribution Guidelines](https://github.com/nlohmann/json/blob/develop/.github/CONTRIBUTING.md) for detailed information.`

:memo: overworked templates 2017-10-29 16:32:23 +01:00			`- [ ] Changes are described in the pull request, or an [existing issue is referenced](https://github.com/nlohmann/json/issues).`
			`- [ ] The test suite [compiles and runs](https://github.com/nlohmann/json/blob/develop/README.md#execute-unit-tests) without error.`
			`- [ ] [Code coverage](https://coveralls.io/github/nlohmann/json) is 100%. Test cases can be added by editing the [test suite](https://github.com/nlohmann/json/tree/develop/test/src).`
:bookmark: set version to 3.1.0 - updated documentation wrt. new repository layout - temporarily switched off Homebrew --HEAD building (can only be switched on after release) - set copyright date to 2018 2018-02-01 22:20:26 +01:00			- [ ] The source code is amalgamated; that is, after making changes to the sources in the `include/nlohmann` directory, run `make amalgamate` to create the single-header file `single_include/nlohmann/json.hpp`. The whole process is described [here](https://github.com/nlohmann/json/blob/develop/.github/CONTRIBUTING.md#files-to-change).
Create PULL_REQUEST_TEMPLATE.md 2016-02-20 23:22:46 +01:00
			`## Please don't`

Adding 4.8 test to travis 2018-09-25 18:15:29 +02:00			- The C++11 support varies between different compilers and versions. Please note the [list of supported compilers](https://github.com/nlohmann/json/blob/master/README.md#supported-compilers). Some compilers like GCC 4.7 (and earlier), Clang 3.3 (and earlier), or Microsoft Visual Studio 13.0 and earlier are known not to work due to missing or incomplete C++11 support. Please refrain from proposing changes that work around these compiler's limitations with `#ifdef`s or other means.
Create PULL_REQUEST_TEMPLATE.md 2016-02-20 23:22:46 +01:00			- Specifically, I am aware of compilation problems with Microsoft Visual Studio (there even is an [issue label](https://github.com/nlohmann/json/issues?utf8=✓&q=label%3A%22visual+studio%22+) for these kind of bugs). I understand that even in 2016, complete C++11 support isn't there yet. But please also understand that I do not want to drop features or uglify the code just to make Microsoft's sub-standard compiler happy. The past has shown that there are ways to express the functionality such that the code compiles with the most recent MSVC - unfortunately, this is not the main objective of the project.
Some typos 2020-02-02 10:29:37 +01:00			`- Please refrain from proposing changes that would break [JSON](https://json.org) conformance. If you propose a conformant extension of JSON to be supported by the library, please motivate this extension.`
Create PULL_REQUEST_TEMPLATE.md 2016-02-20 23:22:46 +01:00			`- Please do not open pull requests that address multiple issues.`