Skip to content

Commit 06cbe56

Browse files
authored
Fix typo in contribution description (#456)
1 parent 87eec41 commit 06cbe56

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

.github/workflows/lint.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ jobs:
2626
- name: Install dependencies
2727
run: |
2828
cd backend
29-
uv sync
29+
uv sync --only-group lint
3030
3131
- name: Run lint
3232
run: |

backend/README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,16 @@
33
## Docker
44

55
> [!IMPORTANT]
6-
> Due to Docker context limitations, you cannot successfully build a image using a Dockerfile in the current directory
6+
> Due to Docker context limitations, you can't build an image in this directory
77
88
1. Make sure you're at the root of the project
9-
2. Run the following Docker command to build a image:
9+
2. Run the following Docker command to build container:
1010

1111
```shell
1212
docker build -f backend/backend.dockerfile -t fba_backend_independent .
1313
```
1414

15-
3. Start decker image
15+
3. Start container
1616

1717
```shell
1818
docker run -d fba_backend_independent -p 8000:8000 --name fba_app
@@ -23,30 +23,30 @@
2323
1. Prerequisites
2424

2525
You'll need the following prerequisites:
26-
- Any Python version between Python >= 3.10
27-
- virtualenv or other virtual environment tool
28-
- git
26+
- Any python version between Python >= 3.10
27+
- Git
2928
- [uv](https://docs.astral.sh/uv/getting-started/installation/)
29+
- Fork this repository to your GitHub account
3030

3131
2. Installation and setup
3232

33+
Clone your fork and cd into the repo directory
34+
3335
```shell
34-
# Clone your fork and cd into the repo directory
3536
git clone https://github.com/<your username>/fastapi_best_architecture.git
3637

3738
cd fastapi_best_architecture/backend
3839

39-
vv venv
40+
uv venv
4041

4142
uv pip install -r requirements.txt
4243
```
4344

44-
3. Check out a new branch and make your changes
45+
3. Checkout a new branch and make your changes
4546

4647
```shell
4748
# Checkout a new branch and make your changes
4849
git checkout -b your-new-feature-branch
49-
# Make your changes...
5050
```
5151

5252
4. Run linting

0 commit comments

Comments
 (0)