StackGuardian / StackGuardian/tirith

🚀 Add more unit tests for the project

Open
#91 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement hacktoberfest
Dominant language
Python
Stars
165
Forks
42
Avg merge
1d 3h
Merged PRs (30d)
11

Description

Is your feature request related to a problem? Please describe.
Currently there are still many parts of the project that aren't covered by unit tests yet.

Describe the solution you'd like
I'd like to see more unit tests added. I acknowledge this is a very big task, I'd split this task into smaller chunks that can be done at one time thus easier to review, e.g. add a unit test for a case for an existing function.

For the next step, we can add a unit test coverage checker in this project's github action workflow, so that the actions can check what part of the project that's still missing unit tests and avoid any coverage percentage decrease (this can be caused by either deleting existing unit tests, or adding a feature without unit test)

Contributor guide

Open the contributing guide

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.

Research direction

Start by surveying the existing Python unit tests and project areas that lack coverage; the issue does not name specific files or test entry points. Then inspect the GitHub Actions workflow for where coverage checking could fit. Done means a smaller, explicitly scoped test improvement or a defined coverage-checking change, rather than the entire broad request.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, python
Domain
ci-cd, testing
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.