Skip to content

Commit c79268b

Browse files
Updating readme.md
1 parent 86d7572 commit c79268b

1 file changed

Lines changed: 12 additions & 5 deletions

File tree

readme.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Cognitive Code Analysis is an approach to understanding and improving code by fo
66
77
[Source: Human Cognitive Limitations. Broad, Consistent, Clinical Application of Physiological Principles Will Require Decision Support](https://www.ncbi.nlm.nih.gov/pmc/articles/PMC5822395/)
88

9-
## Installation
9+
## Installation ⚙️
1010

1111
```bash
1212
composer require --dev phauthentic/cognitive-code-analysis
@@ -42,7 +42,7 @@ Note that this requires a version control system (VCS) to be set up, such as Git
4242
bin/phpcca churn <path-to-folder>
4343
```
4444

45-
## Documentation
45+
## Documentation 📚
4646

4747
* [Cognitive Complexity Analysis](./docs/Cognitive-Complexity-Analysis.md#cognitive-complexity-analysis)
4848
* [Why bother?](./docs/Cognitive-Complexity-Analysis.md#why-bother)
@@ -56,8 +56,9 @@ bin/phpcca churn <path-to-folder>
5656
* [Examples](#examples)
5757
* [Wordpress WP_Debug_Data](#wordpress-wp_debug_data)
5858
* [Doctrine Paginator](#doctrine-paginator)
59+
* [Reporting Issues](#reporting-issues)
5960

60-
## Resources
61+
## Resources 🔗
6162

6263
These pages and papers provide more information on cognitive limitations and readability and the impact on the business.
6364

@@ -72,7 +73,7 @@ These pages and papers provide more information on cognitive limitations and rea
7273
* **Halstead Complexity**
7374
* [Halstead Complexity Measures](https://en.wikipedia.org/wiki/Halstead_complexity_measures)
7475

75-
## Examples
76+
## Examples 📖
7677

7778
### Cognitive Metrics
7879

@@ -119,7 +120,13 @@ Class: Doctrine\ORM\Tools\Pagination\Paginator
119120
└───────────────────────────────────────────┴────────┴───────────┴─────────┴───────────┴──────────┴───────┴────────────┴───────────┴────────────┘
120121
```
121122

122-
## License
123+
## Reporting Issues 🪲
124+
125+
If you find a bug or have a feature request, please open an issue on the [GitHub repository](https://github.com/Phauthentic/cognitive-code-analysis/issues/new).
126+
127+
Especially the AST-parser used under the hood to analyse the code might have issues with certain code constructs, so please provide a minimal example that reproduces the issue.
128+
129+
## License ⚖️
123130

124131
Copyright Florian Krämer
125132

0 commit comments

Comments
 (0)