prometheus / prometheus/common

Release v1.0.0 stable version of common (or subset of packages)

Open
#771 26 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

question
Dominant language
Go
Stars
295
Forks
367
Avg merge
2d 10h
Merged PRs (30d)
18

Description

Hi 👋🏽

It's time to take common to a higher stability level. We damage the ecosystem by making breaking changes (I authored some 🙃 ) e.g. https://github.com/thanos-io/thanos/pull/8162 (pulling some dep suddenly break another dep etc.).

  • Why not doing this?
  • Should we have a separate common/exp module with 0.x like we do in client_golang now for experimental packages (that we can move to stable mod one day?)
  • Should we be more strict on merging new code (in terms of API flexibility, naming) given it will be hard to change?
  • Do we need to do any major changes before 1.0?

If we need more data on how much problematic 0.x common version is, to motivate this, I can try to research exact numbers, let me know!

cc @aknuds1 @SuperQ

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 current common module and the breaking-change example in PR 8162. Evaluate whether a stable v1.0.0, a separate experimental module, or broader API changes are needed. Done means the project has a decided stability policy and a concrete release plan.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
release
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.