MaibornWolff / MaibornWolff/codecharta
Add support for all CodeMaat analysis formats
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 529
- Forks
- 56
- Avg merge
- 7h 17m
- Merged PRs (30d)
- 34
Description
... or add a disclaimer to readme and documentation
Description
At the moment we only support the "coupling" mode of CodeMaat. This is not explicitly stated in the readme (/documentation) of the importer, just implicitly in the suggested command line call of CodeMaat.
The other metrics, that are available from Code Maat can't be imported correctly via the CodeMaatImporter (because they are not edge-metrics and reference a null node). They can be imported via the general CSVImporter.
Development notes (optional Task Breakdown)
- Change the CodeMaat Importer to be able to handle the other more general metrics that the tool produces or
- Change the readme and documentation to advise the users to use either the CodeMaat importer or the CSVImporter depending on their use case
documentation = gh-pages
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 reading the CodeMaatImporter README and the linked gh-pages documentation, then compare the supported coupling mode with the general CSVImporter behavior described in the issue. Determine whether the intended outcome is broader importer support or documentation that directs users to the appropriate importer. Done means all relevant CodeMaat formats work correctly or the README and documentation clearly state the supported use cases.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- data, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100