Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 62 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
## Backend

1. Prerequisites

- Python >= 3.10
- Git
- [uv](https://docs.astral.sh/uv/getting-started/installation/)
- Fork this repository to your GitHub account

2. Installation and setup

Clone your forked repository:

```shell
git clone https://github.com/<your account>/fastapi_best_architecture.git
```

Go to the root directory of the project, open the terminal, and run the following command:

```sh
uv sync
```

3. Checkout

Checkout a new branch and make your changes

```shell
git checkout -b your-new-feature-branch
```

4. Format and Lint

Auto-formatting and lint via `prek`

```shell
prek run --all-files
```

5. Commit and push

Commit your changes and push your branch to the GitHub.

6. PR

Create a PR via GitHub

## Scripts

> [!WARNING]
>
> The following script may not apply to the Windows platform
>
> It is recommended to execute under the backend directory, and chmod authorization may be required

- `migrate.sh`: Perform automatic database migration

- `scripts/format.sh`: Perform ruff format check

- `scripts/lint.sh`: Perform prek formatting

- `scripts/export.sh`: Execute uv export dependency package
63 changes: 0 additions & 63 deletions backend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,66 +16,3 @@
```shell
docker run -d -p 8000:8000 --name fba_server fba_backend_independent
```

## Contributing

1. Prerequisites

- Python >= 3.10
- Git
- [uv](https://docs.astral.sh/uv/getting-started/installation/)
- Fork this repository to your GitHub account

2. Installation and setup

Clone your forked repository:

```shell
git clone https://github.com/<your account>/fastapi_best_architecture.git
```

Go to the root directory of the project, open the terminal, and run the following command:

```sh
uv sync --frozen
```

3. Checkout

Checkout a new branch and make your changes

```shell
git checkout -b your-new-feature-branch
```

4. Format and Lint

Auto-formatting and lint via `prek`

```shell
prek run --all-files
```

5. Commit and push

Commit your changes and push your branch to the GitHub.

6. PR

Create a PR via GitHub

## Scripts

> [!WARNING]
>
> The following script may not apply to the Windows platform
>
> It is recommended to execute under the backend directory, and chmod authorization may be required

- `pre_start.sh`: Perform automatic database migration

- `scripts/format.sh`: Perform ruff format check

- `scripts/lint.sh`: Perform prek formatting

- `scripts/export.sh`: Execute uv export dependency package