diff options
| author | Mike Bayer <mike_mp@zzzcomputing.com> | 2019-01-14 16:51:04 -0500 |
|---|---|---|
| committer | Mike Bayer <mike_mp@zzzcomputing.com> | 2019-01-14 16:51:04 -0500 |
| commit | 5f697cb6729761cc0422597339f7b5e41382b803 (patch) | |
| tree | 46810e4a312a28937238776b3b8e2977db446a06 /.github | |
| parent | e8cddcf723bbfe8e66b302e2b8b7801b38640c93 (diff) | |
| download | sqlalchemy-5f697cb6729761cc0422597339f7b5e41382b803.tar.gz | |
Pull request template final
Change-Id: Id94b90a58753e044ec3495601fea4c12e79d6e3d
Diffstat (limited to '.github')
| -rw-r--r-- | .github/pull_request_template.md | 30 |
1 files changed, 14 insertions, 16 deletions
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 81cd523e5..ce2f00321 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -4,9 +4,7 @@ <!-- Describe your changes in detail --> ### Checklist -<!-- go over following points. check them with an `x` if they do apply, -(they turn into clickable checkboxes once the PR is submitted, so no need -to do everything at once) +<!-- go over following points. check them with an `x` if they do apply, (they turn into clickable checkboxes once the PR is submitted, so no need to do everything at once) --> @@ -15,27 +13,27 @@ This pull request is: - [ ] A documentation / typographical error fix - Good to go, no issue or tests are needed - [ ] A short code fix - - [ ] I have filed [a bug report](https://github.com/sqlalchemy/sqlalchemy/issues) which includes - a complete [MCVE](http://stackoverflow.com/help/mcve) illustrating in simple code form - the expected behavior and how the library deviates from it + - [ ] I have filed [a bug report](https://github.com/sqlalchemy/sqlalchemy/issues) which includes a complete [MCVE](http://stackoverflow.com/help/mcve) illustrating in simple code form the expected behavior and how the library deviates from it. This is necessary **no matter how obvious the problem and/or fix is**, because this is how we track the issue being repaired for users that need to know about it, as well as where the correct fix can be agreed upon - the problem you are fixing is more often than not more complicated than it seems. - [ ] My git commit includes a `Fixes: #<issue number>` comment with the above bug report number - [ ] My code fix includes a unit test, which is typically based on the MCVE I did above - [ ] I then **ran the tests**, using the instructions at [README.unittests.rst](https://github.com/sqlalchemy/sqlalchemy/blob/master/README.unittests.rst) - [ ] I don't know how to write a test for this. In which case please FILE A BUG ONLY. + - Follow up availability: + - [ ] I **Will** be able to respond in a timely fashion to additional requests for changes and detail. + - [ ] I **Will Not** be able to respond in a timely fashion to additional requests for changes and detail. + - if you checked "Will Not", please FILE A BUG ONLY. - [ ] A new feature implementation - - [ ] I have filed [a bug report](https://github.com/sqlalchemy/sqlalchemy/issues) which includes - a complete description of the new behavior, including an a Python code example that illustrates - how the feature would work. - - [ ] The new feature request was approved by SQLAlchemy maintainers who requested that I submit - a pull request. + - [ ] I have filed [a bug report](https://github.com/sqlalchemy/sqlalchemy/issues) which includes a complete description of the new behavior, including an a Python code example that illustrates how the feature would work. + - [ ] The new feature request was **approved by SQLAlchemy maintainers** who requested that I submit a pull request. - [ ] My git commit includes a `Fixes: #<issue number>` comment with the above bug report number - [ ] My code fix includes unit tests that assert the behavior is as expected. - [ ] I then **ran the tests**, using the instructions at [README.unittests.rst](https://github.com/sqlalchemy/sqlalchemy/blob/master/README.unittests.rst) - - [ ] I don't know how to write the tests. in which case please GET HELP FROM THE MAINTAINERS - on the above mentioned issue how tests for this feature should be structured. + - [ ] I don't know how to write the tests. in which case please GET HELP FROM THE MAINTAINERS on the above mentioned issue how tests for this feature should be structured. + - Follow up availability: + - [ ] I **Will** be able to respond in a timely fashion to additional requests for changes and detail. + - [ ] I **Will Not** be able to respond in a timely fashion to additional requests for changes and detail. + - if you checked "Will Not", please FILE A BUG ONLY. -<!-- Note that **we do not accept one-liner code fix pull requests with no tests**. Code that is not -tested is itself **a bug**. We will help you fix any problem you have, as long as you produce -[issue reports](https://github.com/sqlalchemy/sqlalchemy/issues) that include code samples, stack traces, and most preferably complete standalone test cases. --> +<!-- Note that **we do not accept one-liner code fix pull requests with no tests**. Code that is not tested is itself **a bug**. We will help you fix any problem you have, as long as you produce [issue reports](https://github.com/sqlalchemy/sqlalchemy/issues) that include code samples, stack traces, and most preferably complete standalone test cases. --> **Have a nice day!** |
