MaibornWolff / MaibornWolff/codecharta
Fix inconsistency between handling of AttributeDescriptors
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 529
- Forks
- 56
- Avg merge
- 7h 17m
- Merged PRs (30d)
- 34
Description
We have multiple analysers that produce attribute descriptions. Most of them implement the "AttributeGenerator" interface and are added to the ccsh using the AttributeGeneratorRegistry to handle this. However, some others (e.g. SourceMonitorImporter) handle it themselves by passing a function to the project builder.
To improve maintainability, we should decide on one of these approaches an implement it across all analyers.
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 inventorying the analyzers using the AttributeGenerator interface and AttributeGeneratorRegistry, then compare them with SourceMonitorImporter and the project-builder function path. The work is done when one consistent approach is chosen and applied across all analyzers without changing attribute-description behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- devtools
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100