Repository navigation
Epic: Add Test suite and coverage for the Scribe-Server v1 API #76
Description
What this is about
Scribe-Server works, but it has no tests. Right now, if someone changes the code and breaks something, nothing tells us. We only find out when the client app(Android or iOS) stops working.
This epic fixes that, one small piece at a time.
The proposed plan
We're at 0% test coverage. We're not going to fix that in one giant PR. Instead, each sub-issue covers one small part of the code. Someone picks one, writes tests for it, and coverage goes up a little.
0% -> 1% -> 3% -> 8% -> and so on, until we're happy with the number.
Slow is fine. The only rule is that it always goes up, never down.
How to help
- Pick a sub-issue from the list below and comment that you're taking it.
- Write the tests.
- Run
make testto check they pass. - Check that coverage went up:
go test ./... -coverprofile=coverage.out
go tool cover -func=coverage.out | tail -1Put the before and after numbers in your PR, like Coverage: 3.4% -> 5.1%.
5. Open a PR, link it to the sub-issue, and ask for review.
6. When it's merged, pick the next one.
If coverage didn't go up, the tests probably aren't reaching new code. Mention it in the PR and we'll look together.
Start here
I'll do the smallest sub-issue first and get it merged, so there's a real example in the repo to copy from. Wait for that one before starting yours if you're unsure what a good test PR looks like here.
New to Go testing? The early sub-issues are marked good first issue — they're plain functions with no database involved. Good place to start.
Activity
[-]Epic: test coverage for the Scribe-Server API[/-][+]Epic: Add Test suite and coverage for the Scribe-Server v1 API [/+]BuildLanguageStatResponse#77DeleMike commentedon Aug 24, 2026
This will be the general board to track all testing issues @andrewtavis @axif0
I believe when we have done enough testing(I don't believe testing can ever end), then we will close this issue(i.e. stop adding new sub-issues to this)
What do you think?
andrewtavis commentedon Aug 24, 2026
All looks great, @DeleMike! 😊 Thanks for all your efforts here. My question is, which of these issues can be worked on before Scribe-Server is finalized with the latest version of Scribe-Data?
DeleMike commentedon Aug 24, 2026
Thanks @andrewtavis !
Uhm, all the “good-first-issues”. I have sent in a PR for the testing guide and after that is reviewed and merged, I will work on a sample PR that stand as the accepted baseline for all test PRs.
We all will look at it, if it follows the
TESTING.mdguidelines, amongst other things we are examining, before we merge the test PR in.First, I need a look at #93, thanks.
ashb155 commentedon Aug 27, 2026
hi @DeleMike @andrewtavis , I'm just getting started here and wanted to know more about a few good first issues i could work on?
thanks so much
andrewtavis commentedon Aug 27, 2026
Thanks for writing in, @ashb155 :) @DeleMike, I suggested that @ashb155 could also support here as we're running low on Scribe-Android issues at the moment. Let us know if there's one of the good first issues that could work!
DeleMike commentedon Aug 28, 2026
Happy to have you contribute here @ashb155 😊
I will ping you in an issue.
Thanks @andrewtavis