johnthagen/clion-cppcheck

Clarify initial setup steps

Open

#58 opened on Dec 23, 2020

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Java (7 forks)github user discovery
docenhancementhelp wanted

Repository metrics

Stars
 (37 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

The plugin has just an average rating at https://plugins.jetbrains.com/plugin/8143-cppcheck/reviews.

It seems most of them stem from the documentation for the initial setup being confusing. We need to figure out what confuses people and improve the documentation accordingly. Maybe even rewrite it from scratch.

Contributor guide

Research direction
Analyze user reviews on JetBrains marketplace to identify common complaints about setup documentation. Create a list of confusing steps and propose clarifications or a rewrite.
Tech stack
java
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75