For general developer guidelines, please see out current Developer Guide at
[Develop](https://www.sqlalchemy.org/develop.html).
+## Pull requests require an approved issue ##
+
+**We accept pull requests only for issues that a maintainer has marked with
+the `open for pull requests` label.** A pull request that doesn't reference
+such an issue is closed automatically, by a bot, as soon as it's opened.
+
+The reason is that the vast majority of unsolicited pull requests are
+solutions to a problem we haven't agreed on yet, and reviewing them costs far
+more than writing them does. Settling the approach on the issue first means
+nobody writes code that was never going to be merged.
+
+The process is:
+
+1. **Open an issue** describing the problem or the feature, with a complete,
+ runnable example. For a bug, that means a script we can run that shows the
+ wrong behavior.
+2. **Wait for a maintainer** to look at it. If we agree the change is wanted
+ and that an outside contribution is the right way to get it, we add the
+ `open for pull requests` label.
+3. **Then open the pull request**, referencing the issue.
+
+Some labels you'll see on issues, and what they mean for contributors:
+
+| label | meaning |
+| --- | --- |
+| `open for pull requests` | we'd welcome a pull request for this |
+| `code review in progress` | someone is already working on it, in a pull request or directly in gerrit |
+| `NO pull requests please` | we're handling this one ourselves; please don't |
+
+An issue with none of these labels hasn't been decided on yet. Asking on the
+issue is fine; opening a pull request to make the case is not, and it will be
+closed.
+
+This applies to documentation and typo fixes too. We know that feels heavy
+for a one-line change, but the alternative is a rule with exceptions that have
+to be argued about, and we'd rather have one rule. A typo is a two-line issue
+and we'll label it quickly.
+
## Note on use of AI, agents and bots ##
Some of us here use large language models (LLM) to help us with our work, and
validations:
required: false
+ - type: markdown
+ attributes:
+ value: "
+**Thinking of submitting a pull request for this?** Please wait until a
+maintainer has added the `open for pull requests` label to this issue. Pull
+requests that don't reference an issue carrying that label are closed
+automatically.
+"
+
- type: markdown
attributes:
value: "**Have a nice day!**"
validations:
required: false
+ - type: markdown
+ attributes:
+ value: "
+**Thinking of submitting a pull request for this?** Please wait until a
+maintainer has added the `open for pull requests` label to this issue. Pull
+requests that don't reference an issue carrying that label are closed
+automatically.
+"
+
- type: markdown
attributes:
value: "**Have a nice day!**"
validations:
required: false
+ - type: markdown
+ attributes:
+ value: "
+**Thinking of submitting a pull request for this?** Please wait until a
+maintainer has added the `open for pull requests` label to this issue. Pull
+requests that don't reference an issue carrying that label are closed
+automatically.
+"
+
- type: markdown
attributes:
value: "**Have a nice day!**"
<!-- Provide a general summary of your proposed changes in the Title field above -->
+**This project accepts pull requests only for issues that a maintainer has
+marked with the `open for pull requests` label.**
+
+A pull request that doesn't reference such an issue **is closed
+automatically**. That isn't a judgment on your change: it's how we settle on
+an approach before anyone spends time writing code, and how we keep two
+people from doing the same work at once.
+
+The issue you reference has to be:
+
+* in this repository,
+* open,
+* labeled `open for pull requests`, and
+* not already labeled `code review in progress`, which means someone is
+ working on it already.
+
+If there's no such issue yet, open one describing the problem or the feature,
+including a complete, runnable example, and wait for a maintainer to add the
+label. Please don't open a pull request first and ask for the label
+afterwards.
+
+### Fixes
+
+<!-- Put the issue number after the "#" below, e.g. "Fixes: #1234".
+ Leaving this blank means this pull request will be closed. -->
+
+Fixes: #
+
### Description
-<!-- 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)
-
--->
-
-This pull request is:
-
-- [ ] A documentation / typographical / small typing error fix
- - Good to go, no issue or tests are needed
-- [ ] A short code fix
- - please include the issue number, and create an issue if none exists, which
- must include a complete example of the issue. one line code fixes without an
- issue and demonstration will not be accepted.
- - Please include: `Fixes: #<issue number>` in the commit message
- - please include tests. one line code fixes without tests will not be accepted.
-- [ ] A new feature implementation
- - please include the issue number, and create an issue if none exists, which must
- include a complete example of how the feature would look.
- - Please include: `Fixes: #<issue number>` in the commit message
- - please include tests.
-
-**Have a nice day!**
+
+<!-- Describe your changes in detail. -->
projects / thirdparty / sqlalchemy / sqlalchemy.git / commitdiff
