🚀 Feature: mark cli API as stable

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

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
20/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Active
Domain
cli

Research direction

This is a discussion issue rather than a scoped change: first find where the CLI prints the experimental-API warning (search the source for the warning text) and identify the public API entry point it refers to. Read the TypeScript rewrite status in the repository before deciding whether the warning can be removed. Done would mean maintainers agree on a stability definition and the warning/docs are updated accordingly; no implementation should start until that decision is recorded.

Written by the indexing model from the issue text.

Description

status: in discussion type: feature
Feature Request Checklist
Overview

Currently our API triggers a warning (which is quite old) about it being experimental. Thoughts on when we should consider it stable? I'm thinking after the TypeScript rewrite. @all-contributors/maintainers what do y'all think?

Additional Info

No response

Dominant language
JavaScript
Stars
427
Forks
157
Avg merge
1d 2h
Merged PRs (30d)
57

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 all-contributors/cli

All issues in all-contributors/cli

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.