chapel-lang/chapel

[Documentation]: Expand docs for chplcheck rules

Open

#27,339 opened on Jun 3, 2025

View on GitHub
 (7 comments) (0 reactions) (1 assignee)Chapel (446 forks)auto 404
area: Docsgood first issue

Repository metrics

Stars
 (2,010 stars)
PR merge metrics
 (PR metrics pending)

Description

Today, we document all of the chplcheck rules: https://chapel-lang.org/docs/main/tools/chplcheck/chplcheck.html#current-rules

But for each one we can include an example of where the rule would warn by adding new files to tools/chplcheck/examples. We should expand the list of files here to expand the chplcheck rule documentation

Contributor guide

Research direction
Study the existing chplcheck rules documentation and examples directory. Create new example files following the existing pattern, then update the documentation to link to them.
Tech stack
None
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.
1-3 hours
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
GitChapel
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80