nim-works/nimskull

Include valgrind as part of CI

Open

#588 opened on Mar 17, 2023

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Nim (39 forks)auto 404
cicompilergood first issuehelp wanted

Repository metrics

Stars
 (346 stars)
PR merge metrics
 (PR metrics pending)

Description

In the past while it has become evident that there are a number of fundamnetal issues with our memory management implementations (refc, arc, and orc) that lead them to be unsafe, especially in conjunction with threading. Before even getting to complex multi-threading scenarios we can eliminate lots of issues by addressing valgrind's findings.

TODO:

  • Enable valgrind for tests in CI; a number of tests already support this
  • tackle a few quick wins to get some momentum

Contributor guide

Research direction
Inspect the CI configuration files (e.g., .github/workflows) to understand the current test setup, then identify tests that already support valgrind as mentioned in the TODO list, and enable valgrind for all tests by adding a valgrind step or using existing support.
Tech stack
None
Domain
devops
Issue type
DevOps
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
CI/CDvalgrind
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65