posit-dev / posit-dev/connect-extensions

Polish runtime-version-scanner

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

Nobody has claimed this yet.

Dominant language
R
Stars
10
Forks
8
Avg merge
5d 18h
Merged PRs (30d)
1

Description

Baselines:

  • Rewrite README (currently 3 lines): what it does, who it's for, setup/config, how to use
  • Rewrite description: concise, states functionality + value
  • Add a "how this works" panel: surface the Visitor API Key / Connect API identity mechanism ("signed in as {you}; scanning the content you can see")
  • Add why-comments to the source

App-specific:

  • Add tests for connect_module.R and app.R server logic
  • Delete dead CSS and unused code
  • Move library() calls to DESCRIPTION (#283)
  • Migrate httr → httr2 (separate PR)
  • Confirm search_content pagination past 500 items
  • Bump version, CHANGELOG, checksums

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 inventorying the README, DESCRIPTION, connect_module.R, and app.R, then separate the documentation, test, cleanup, migration, and release tasks into independently verifiable changes. Done requires the README and description updates, how-this-works panel, why-comments, tests for the named R files, cleanup, and the requested version, changelog, checksum, and pagination checks.

Written by the indexing model from the issue text.

Assessment

Tech stack
r
Domain
documentation, testing, tooling
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.