nodejs / nodejs/package-maintenance

Suggestion: CITGM for a module dependants

Open
#84 10 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

pull request wanted
Dominant language
No language data
Stars
423
Forks
147
PR merge metrics
No merged PRs in 30d

Description

Developing a library at scale is hard, and as a maintainer the goal is to avoid unwanted breakage and regression. Especially when doing breaking changes, it's of critical importance to validate the impact of those changes, more or less how we do it in core.

In pino, we have done https://github.com/pinojs/pino-integration. In Fastify, we have done https://github.com/fastify/fastify-citgm. I think there is a space to build a generic and supported tool for testing dependant projects, so that we avoid breakages when doing releases.

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 reviewing the linked pino-integration and fastify-citgm projects to understand the existing approaches to testing dependent projects. A complete contribution would define a generic, supported tool and its scope for validating release impact without breaking dependants.

Written by the indexing model from the issue text.

Assessment

Tech stack
nodejs
Domain
testing-qa, tooling
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.