Skip to content

Fix typos in README.md #152

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tugrulates merged 2 commits into from
Sep 29, 2025
Merged

Fix typos in README.md #152

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0e376e5
Initial plan
Copilot Sep 29, 2025
0630164
Fix typos in README.md
Copilot Sep 29, 2025
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
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ If running locally instead, you will need Python3 with [hatch](https://github.co

Skip this section if you are using Dev Containers or Codespaces.

All following setup is optional. They are meant to increase life-of-quality during development.
All following setup is optional. They are meant to increase quality-of-life during development.

- To run 'hatch' commands (see below):

Expand Down Expand Up @@ -88,7 +88,7 @@ Check out the example app code to get accustomed to the setup. You will need to

There is a robust CI pipeline already setup. It contains the following jobs.

- **lint**: Checks that all lint checkers are happy amd would succeed.
- **lint**: Checks that all lint checkers are happy and would succeed.
- **fmt**: Format code with black and isort.
- **test**: Checks that all unit tests are passing on Linux, Mac, and Windows, with different Python versions.
- **coverage**: Checks that code coverage is above 80%. Optionally, uploads coverage to [Codecov](https://codecov.io).
Expand All @@ -108,6 +108,6 @@ I hope you will find this template useful. You can create an issue if you have a

## 🚩 Roadmap

The project scaffolds a basic CLI application. You can build upon this for your own, or you can strip the CLI parts altogether to build a different type of Python package. Actual templating a la [Cookiecuter](https://www.cookiecutter.io/) could be useful.
The project scaffolds a basic CLI application. You can build upon this for your own, or you can strip the CLI parts altogether to build a different type of Python package. Actual templating a la [Cookiecutter](https://www.cookiecutter.io/) could be useful.

This project does not yet include an end-to-end test. It would be an improvement to automatically download CI artifacts from the main branch and run tests against them.
Loading