actions / actions/toolkit

Please remove misleading hope-giving line from main README.md

Open
#1,532 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
TypeScript
Stars
5.9k
Forks
1.8k
PR merge metrics
No merged PRs in 30d

Description

Describe the enhancement
Please either remove the line below from README.md or commit to it.
Potentially link to issue where progress can be tracked. e.g. the 3-year stagnant https://github.com/actions/runner/issues/662

Code Snippet
https://github.com/actions/toolkit/blob/c5c786523e095ca3fabfc4d345e16242da34e108/packages/core/README.md#L70

Additional information
The line was added 4 years ago in https://github.com/actions/toolkit/commit/713902387ec57f76f4fdbef8f1f179a5ef3c2049 (#172) by @bryanmacfarlane, I have a feeling it is one of those eternal "temporary" comments.

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

Review README.md and the referenced packages/core/README.md location first, then read the linked actions/runner issue for context on the stalled promise. Done means the misleading line is removed or replaced with a maintained progress link, according to the maintainers' decision.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.