sqlalchemy/.github/pull_request_template.md

Description

Checklist

This pull request is:

• A documentation / typographical error fix
  • Good to go, no issue or tests are needed
• A short code fix
  • There is a bug report already, or I have filed a bug report which includes a test case (MCVE) illustrating in simple code form the expected behavior and how the library deviates from it.
  • 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
  • I don't know how to write a test for this. In which case please FILE A BUG ONLY.
  • I will be able to respond in a timely fashion to additional requests for changes and detail.
• A new feature implementation
  • There is a bug report already, or I have filed a bug report 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
  • 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 will be able to respond in a timely fashion to additional requests for changes and detail.

Have a nice day!