Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Add unit/integration tests for core functionality

Open
  • Is something wrong?
#24 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
48/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
python, shell
Domain
testing

Research direction

Start by reading hermeskey-server.py for its socket handling, JSON parsing and error paths, then look at .github/workflows/ci.yml to see where a test step would go. No tests/ directory exists yet, so the framework choice (pytest or bats) is open and needs confirming with maintainers first. Done means a pytest suite covering the server's unit paths runs under python3 -m pytest tests/ and passes in CI.

Written by the indexing model from the issue text.

Description

enhancement help wanted

Issue

The project has no automated tests (unit or integration).

Suggested Test Coverage

Unit Tests
  • hermeskey-server.py: Socket communication, JSON parsing, error handling
  • Config parsing and validation
  • Model name validation
Integration Tests
  • Full transcription flow (mock server)
  • Hotkey toggle behavior
  • Clipboard operations
Test Framework

Consider:

  • pytest for Python tests
  • bashunit or bats for shell script tests

CI Integration

Add to .github/workflows/ci.yml:

- name: Run tests
  run: |
    python3 -m pytest tests/
    ./tests/shell-test.sh

Benefits

  • Catch regressions early
  • Enable safer refactoring
  • Improve code quality
  • Better contributor onboarding
Dominant language
Shell
Stars
0
Forks
0
Avg merge
1h 24m
Merged PRs (30d)
5

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from graygarbage/HermesKey

All issues in graygarbage/HermesKey

Similar issues

More Shell/Bash issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.