]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
Pull request template final
authorMike Bayer <mike_mp@zzzcomputing.com>
Mon, 14 Jan 2019 21:51:04 +0000 (16:51 -0500)
committerMike Bayer <mike_mp@zzzcomputing.com>
Mon, 14 Jan 2019 21:51:04 +0000 (16:51 -0500)
Change-Id: Id94b90a58753e044ec3495601fea4c12e79d6e3d

.github/pull_request_template.md

index 81cd523e5da9cecd9eaf0246ed439d91951d70ec..ce2f00321a388e2bc3f3a6f49948f7c46e762528 100644 (file)
@@ -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!**