Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Document Brakeman limitation DOCS-675 #2081

Conversation

nicklem
Copy link
Contributor

@nicklem nicklem commented Apr 19, 2024

Documents the Brakeman version limitation, prompting users to use Semgrep instead.

👀 Live preview

https://docs-675-document-the-use-of-semgre--docs-codacy.netlify.app/getting-started/supported-languages-and-tools/#semgrep-brakeman

@nicklem nicklem self-assigned this Apr 19, 2024
@github-actions github-actions bot temporarily deployed to Netlify April 19, 2024 15:51 Inactive
Copy link
Contributor

github-actions bot commented Apr 19, 2024

Overall readability score: 53.96 (🔴 -0.01)

File Readability
supported-languages-and-tools.md 48.02 (🔴 -1.11)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
supported-languages-and-tools.md 48.02 31.48 10.75 13.5 14.9 7.72
  🔴 -1.11 🔴 -0.1 🔴 -0.29 🔴 -0.3 🔴 -0.18 🟢 +0.03

Averages:

  Readability FRE GF ARI CLI DCRS
Average 53.96 42.81 10.88 12.42 12.55 7.91
  🔴 -0.01 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less

Copy link
Contributor

@claudiacarpinteiro claudiacarpinteiro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! 👍
Left a couple of minor notes.

docs/getting-started/supported-languages-and-tools.md Outdated Show resolved Hide resolved
docs/getting-started/supported-languages-and-tools.md Outdated Show resolved Hide resolved
Co-authored-by: Cláudia Carpinteiro <claudiacarpinteiro@users.noreply.github.com>
@github-actions github-actions bot temporarily deployed to Netlify April 22, 2024 12:21 Inactive
@github-actions github-actions bot temporarily deployed to Netlify May 6, 2024 09:08 Inactive
@nicklem nicklem marked this pull request as ready for review May 8, 2024 07:25
@nicklem nicklem requested a review from a team as a code owner May 8, 2024 07:25
@nicklem nicklem requested a review from mrfyda May 8, 2024 07:25
@github-actions github-actions bot temporarily deployed to Netlify May 8, 2024 07:27 Inactive
@nicklem nicklem enabled auto-merge (squash) May 8, 2024 07:32
@nicklem nicklem merged commit ae143a3 into master May 8, 2024
6 checks passed
@nicklem nicklem deleted the DOCS-675-document-the-use-of-semgrep-as-an-alternative-to-older-tools branch May 8, 2024 08:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants