Skip to content

Commit 15e7ce7

Browse files
YuriiMotovsvlandeg
andauthored
📝 Update management-tasks.md to be in line with management-tasks.md in FastAPI repo (#1743)
Update `management-tasks.md` Co-authored-by: Sofie Van Landeghem <svlandeg@users.noreply.github.com>
1 parent c5e203c commit 15e7ce7

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

docs/management-tasks.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ Make sure you use a supported label from the <a href="https://github.com/tiangol
6868
* `refactor`: Refactors
6969
* This is normally for changes to the internal code that don't change the behavior. Normally it improves maintainability, or enables future features, etc.
7070
* `upgrade`: Upgrades
71-
* This is for upgrades to direct dependencies from the project, or extra optional dependencies, normally in `pyproject.toml`. So, things that would affect final users, they would end up receiving the upgrade in their code base once they update. But this is not for upgrades to internal dependencies used for development, testing, docs, etc. Those internal dependencies, normally in `requirements.txt` files or GitHub Action versions should be marked as `internal`, not `upgrade`.
71+
* This is for upgrades to direct dependencies from the project, or extra optional dependencies, normally in `pyproject.toml`. So, things that would affect final users, they would end up receiving the upgrade in their code base once they update. But this is not for upgrades to internal dependencies used for development, testing, docs, etc. Those internal dependencies or GitHub Action versions should be marked as `internal`, not `upgrade`.
7272
* `docs`: Docs
7373
* Changes in docs. This includes updating the docs, fixing typos. But it doesn't include changes to translations.
7474
* You can normally quickly detect it by going to the "Files changed" tab in the PR and checking if the updated file(s) starts with `docs/en/docs`. The original version of the docs is always in English, so in `docs/en/docs`.
@@ -83,9 +83,13 @@ Some tools like Dependabot, will add some labels, like `dependencies`, but have
8383

8484
## Review PRs
8585

86-
If a PR doesn't explain what it does or why, ask for more information.
86+
* If a PR doesn't explain what it does or why, if it seems like it could be useful, ask for more information. Otherwise, feel free to close it.
8787

88-
A PR should have a specific use case that it is solving.
88+
* If a PR seems to be spam, meaningless, only to change statistics (to appear as "contributor") or similar, you can simply mark it as `invalid`, and it will be automatically closed.
89+
90+
* If a PR seems to be AI generated, and seems like reviewing it would take more time from you than the time it took to write the prompt, mark it as `maybe-ai`, and it will be automatically closed.
91+
92+
* A PR should have a specific use case that it is solving.
8993

9094
* If the PR is for a feature, it should have docs.
9195
* Unless it's a feature we want to discourage, like support for a corner case that we don't want users to use.
@@ -103,13 +107,11 @@ A PR should have a specific use case that it is solving.
103107

104108
Dependabot will create PRs to update dependencies for several things, and those PRs all look similar, but some are way more delicate than others.
105109

106-
* If the PR is for a direct dependency, so, Dependabot is modifying `pyproject.toml`, **don't merge it**. 😱 Let me check it first. There's a good chance that some additional tweaks or updates are needed.
107-
* If the PR updates one of the internal dependencies, for example it's modifying `requirements.txt` files, or GitHub Action versions, if the tests are passing, the release notes (shown in a summary in the PR) don't show any obvious potential breaking change, you can merge it. 😎
110+
* If the PR is for a direct dependency, so, Dependabot is modifying `pyproject.toml` in the main dependencies, **don't merge it**. 😱 Let me check it first. There's a good chance that some additional tweaks or updates are needed.
111+
* If the PR updates one of the internal dependencies, for example the group `dev` in `pyproject.toml`, or GitHub Action versions, if the tests are passing, the release notes (shown in a summary in the PR) don't show any obvious potential breaking change, you can merge it. 😎
108112

109113
## Mark GitHub Discussions Answers
110114

111115
When a question in GitHub Discussions has been answered, mark the answer by clicking "Mark as answer".
112116

113-
Many of the current Discussion Questions were migrated from old issues. Many have the label `answered`, that means they were answered when they were issues, but now in GitHub Discussions, it's not known what is the actual response from the messages.
114-
115117
You can filter discussions by <a href="https://github.com/fastapi/sqlmodel/discussions/categories/questions?discussions_q=category:Questions+is:open+is:unanswered" class="external-link" target="_blank">`Questions` that are `Unanswered`</a>.

0 commit comments

Comments
 (0)