MaibornWolff / MaibornWolff/codecharta
Provide guidance in the ccsh help
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 529
- Forks
- 56
- Avg merge
- 7h 17m
- Merged PRs (30d)
- 34
Description
# Feature request
As a first-time user, running `ccsh -h` is overwhelming:
Where do I even start? I have the choice between 18 tools. It would be helpful to know what analyzers are typically useful, so I do not have to look at all 18.
## Description
As a novice user, I want a suggestion which analyzers to use, so that I am not overwhelmed by 18 choices.
## Acceptance criteria
- `ccsh -h` prints the most useful parsers to use: unifiedparser, gitlogparser and merge cover the basics.
- - `ccsh -h` should not be a replacement for a getting started. It should just point out the most important trees in this forest.
- `ccsh -h` should suggest to look at the docs and where to find them
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the ccsh help entry point and reviewing the current output for its analyzer list. Done means ccsh -h highlights unifiedparser, gitlogparser, and merge as useful basics, explains that it is only an orientation, and points users to the documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100