MaibornWolff / MaibornWolff/codecharta
Create a "Getting Started in a typical project" guide
- Dominant language
- TypeScript
- Stars
- 529
- Forks
- 56
- Avg merge
- 7h 17m
- Merged PRs (30d)
- 34
Description
# Feature request
The getting started is good, but it does not reflect a typical project setup. The purpose of the getting started is to show how easy it is to get started. But a guide that shows the setup in a typical project should also exist, especially since the unified parser and coverage importer makes that very easy.
## Description
As a developer in an "typical" project, I want a guide that shows how to combine metrics from multiple sources, so that I do not have to figure it out for myself. A lot of this can be found in the [examples](https://codecharta.com/docs/analysis/examples) section but that does not have an obvious name and the examples are outdated.
This guide could use the following editable drawio drawing to visualize the process:
## Acceptance criteria
- Create a guide named "Getting Started - A typical project setup"
- - Maybe a better name exists, "Getting Started - Combine multiple sources" perhaps.
- - The name should increase chances that it can be found.
- The guide shows how to create then merge the results from unifiedparser, coverageimporter and gitlogparser and then visualize it.
- The guide mentions that projects that use Sonar can also replace unifiedparser and coverageimporter with sonarimporter, if the project has a sonar.
- The guide mentions that unifiedparser can also be replaced with rawtextparser, if unifiedparser does not support the language yet.
- The guide mentions the integration guide, in case the projects needs special metrics that are not available via the standard means.
- This new guide is referenced by the "Getting Started" guide at the end
- The [examples](https://codecharta.com/docs/analysis/examples) might be deleted (as they fulfill the same purpose) or be kept around (to preserve people that link to them already). Any mention of the sourcecodeparser should be removed however as it is deprecated.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with the existing Getting Started guide and the linked analysis examples section, then review the current parser instructions and their references. Done means a discoverable typical-project guide explains combining unifiedparser, coverageimporter and gitlogparser, includes the listed alternatives and integration guidance, is linked from Getting Started, and addresses the outdated examples and sourcecodeparser mention.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100