python/sqlmodel
1
0
Fork 0
mirror of https://github.com/fastapi/sqlmodel.git synced 2026-03-13 09:29:54 +08:00
Code Issues Packages Projects Releases Wiki Activity

📝 Update link syntax to minimal Markdown

Browse Source
This commit is contained in:
Sebastián Ramírez
2026-03-05 19:38:00 +01:00
parent cd951c68ff
commit 73f922b2c9
32 changed files with 159 additions and 159 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/contributing.md
View File

@@ -1,10 +1,10 @@
# Contributing
First, you might want to see the basic ways to [help SQLModel and get help](help.md){.internal-link target=_blank}.
First, you might want to see the basic ways to [help SQLModel and get help](help.md).
## Developing
If you already cloned the <a href="https://github.com/fastapi/sqlmodel" class="external-link" target="_blank">sqlmodel repository</a> and you want to deep dive in the code, here are some guidelines to set up your environment.
If you already cloned the [sqlmodel repository](https://github.com/fastapi/sqlmodel) and you want to deep dive in the code, here are some guidelines to set up your environment.
### Install Requirements Using `uv`
@@ -112,7 +112,7 @@ $ mkdocs serve --dev-addr 8008
The instructions here show you how to use the script at `./scripts/docs.py` with the `python` program directly.
But you can also use <a href="https://typer.tiangolo.com/typer-cli/" class="external-link" target="_blank">Typer CLI</a>, and you will get autocompletion in your terminal for the commands after installing completion.
But you can also use [Typer CLI](https://typer.tiangolo.com/typer-cli/), and you will get autocompletion in your terminal for the commands after installing completion.
If you install Typer CLI, you can install completion with:
@@ -129,7 +129,7 @@ Completion will take effect once you restart the terminal.
### Docs Structure
The documentation uses <a href="https://www.mkdocs.org/" class="external-link" target="_blank">MkDocs</a>.
The documentation uses [MkDocs](https://www.mkdocs.org/).
And there are extra tools/scripts in place in `./scripts/docs.py`.
@@ -175,7 +175,7 @@ The same applies to comments and descriptions, please don't copy paste the conte
### Human Effort Denial of Service
Using automated tools and AI to submit PRs or comments that we have to carefully review and handle would be the equivalent of a <a href="https://en.wikipedia.org/wiki/Denial-of-service_attack" class="external-link" target="_blank">Denial-of-service attack</a> on our human effort.
Using automated tools and AI to submit PRs or comments that we have to carefully review and handle would be the equivalent of a [Denial-of-service attack](https://en.wikipedia.org/wiki/Denial-of-service_attack) on our human effort.
It would be very little effort from the person submitting the PR (an LLM prompt) that generates a large amount of effort on our side (carefully reviewing code).