Skip to content

Commit a08573e

Browse files
committed
update README
1 parent 687640c commit a08573e

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ The image below shows the pipelines visualization for this project:
104104
### Formatting, Linting and Testing
105105

106106
- Run `just format` to format your code
107-
- Run `just lint` to run ruff linter
107+
- Run `just lint` to run linter
108108
- Run `just test` to run the tests
109109
- Run `just validate` to run all of the above (`format`, `lint`, and `test`)
110110

@@ -114,15 +114,15 @@ The image below shows the pipelines visualization for this project:
114114
115115
### Docker
116116

117-
The template includes a multi stage Dockerfile, which produces an image with the code and the dependencies installed. You can build the image with:
117+
This project includes a multi-stage Dockerfile, which produces an image with the code and the dependencies installed. You can build the image with:
118118

119119
```bash
120120
just dockerize
121121
```
122122

123123
### Github Actions
124124

125-
The project includes a Github Actions workflow that runs tests and linters on every push on the main branch. You can find the workflow file in `.github/workflows/main-list-test.yml`.
125+
This project includes a Github Actions workflow that runs the formatters, linters, and tests on every push/PR to the `main` or `develop` branches. You can find the workflow file in `.github/workflows/format-lint-test.yml`.
126126

127127

128128

0 commit comments

Comments
 (0)