Skip to content

Update readme to include coverage #63

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
mintopia merged 2 commits into from
Sep 8, 2025
Merged

Update readme to include coverage #63

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1fb9626
Update readme to include coverage
mintopia Sep 8, 2025
2f52ab8
Allow workflow for PRs with just md changes
mintopia Sep 8, 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 .github/workflows/code-quality.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ on:
branches:
- master
- develop
paths-ignore:
- '**.md'
- 'docs/**'
# paths-ignore:
# - '**.md'
# - 'docs/**'
push:
branches:
- master
Expand Down
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Control
[![codecov](https://codecov.io/github/mintopia/control/graph/badge.svg?token=UH1Y6FBHQW)](https://codecov.io/github/mintopia/control)

## Introduction

Expand Down Expand Up @@ -158,15 +159,16 @@ service:
It's an open source project and I'm happy to accept pull requests. I am terrible at UI and UX, which is why this is
entirely using server-side rendering. If someone wants to use Vue/Laravel Livewire - please go ahead!

We have 100% test coverage, and would like to remain that way.

## Roadmap

The following features are on the roadmap:

- Better UI/UX. I'm currently using [tabler.io](https://tabler.io) and entirely server-side rendering.
- Full-featured API. There's a basic one to support seating plan refreshes. I need to refactor it and improve it.
- UI Customisation from Admin Pages. Currently the UI colours, branding is all either in the `.env` or compiled into the CSS at build.
- Unit Tests. This was very rapidly developed, I'm sorry!
- PHPCS and PHPStan. Should be aiming for PSR-12 and level 8 PHPStan.
- Static Analysis - We should be aiming for level 8 in PHPStan.

## Thanks

Expand Down