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: VS Code plugin open PR list ALA-697 #1936

Merged
merged 24 commits into from
Nov 27, 2023

Conversation

nicklem
Copy link
Contributor

@nicklem nicklem commented Nov 10, 2023

Updates the VS Code extension documentation to cover the open PR list tab and other related updates.

👀 Live preview

https://ala-697-doc-vs-code-plugin-open-pr--docs-codacy.netlify.app/getting-started/integrating-codacy-with-visual-studio-code/

🚧 To do

  • Screenshots
  • Review

Copy link
Contributor

github-actions bot commented Nov 10, 2023

Overall readability score: 54.33 (🟢 +0.01)

File Readability
integrating-codacy-with-visual-studio-code.md 69.36 (🟢 +2.38)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
integrating-codacy-with-visual-studio-code.md 69.36 53.21 9.76 10.5 9.8 6.32
  🟢 +2.38 🟢 +0.21 🟢 +0.85 🟢 +0 🔴 -0.17 🟢 +0.35

Averages:

  Readability FRE GF ARI CLI DCRS
Average 54.33 43.14 10.86 12.35 12.52 7.86
  🟢 +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

@nicklem nicklem self-assigned this Nov 10, 2023
@nicklem nicklem added the don't merge Don't merge this pull request yet label Nov 10, 2023
@github-actions github-actions bot temporarily deployed to Netlify November 13, 2023 13:36 Inactive
@nicklem nicklem force-pushed the ALA-697-doc-vs-code-plugin-open-pr-list branch from 181e68a to 434010f Compare November 13, 2023 13:39
@github-actions github-actions bot temporarily deployed to Netlify November 13, 2023 13:41 Inactive
@github-actions github-actions bot temporarily deployed to Netlify November 14, 2023 15:23 Inactive
@github-actions github-actions bot temporarily deployed to Netlify November 14, 2023 15:31 Inactive
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.

Great work, @nicklem! 💪

Initially, I found it a bit weird to have an overview of the interface before the installation and remaining procedures for the user experience flow, but then I understood that we don't have really a use case for the new "tabs", except going there to see the information, right? 😉
So, I agree that this is the most logical way to structure the content we have at this point. 👌

I left some comments for your validation. 🤓

@nicklem nicklem requested a review from alerizzo November 16, 2023 10:33
@nicklem nicklem marked this pull request as ready for review November 16, 2023 11:00
@nicklem nicklem requested a review from a team as a code owner November 16, 2023 11:00
@nicklem nicklem force-pushed the ALA-697-doc-vs-code-plugin-open-pr-list branch from fa4c499 to 7036335 Compare November 17, 2023 13:19
@github-actions github-actions bot temporarily deployed to Netlify November 17, 2023 13:20 Inactive
Co-authored-by: Cláudia Carpinteiro <[email protected]>
@github-actions github-actions bot temporarily deployed to Netlify November 17, 2023 15:23 Inactive
@github-actions github-actions bot temporarily deployed to Netlify November 20, 2023 09:36 Inactive
@github-actions github-actions bot temporarily deployed to Netlify November 20, 2023 13:42 Inactive
@github-actions github-actions bot temporarily deployed to Netlify November 22, 2023 11:31 Inactive
@github-actions github-actions bot temporarily deployed to Netlify November 24, 2023 10:01 Inactive
@github-actions github-actions bot temporarily deployed to Netlify November 24, 2023 14:08 Inactive
@github-actions github-actions bot temporarily deployed to Netlify November 24, 2023 16:37 Inactive
@github-actions github-actions bot temporarily deployed to Netlify November 27, 2023 09:23 Inactive
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.

LGTM! 🚀
I left a small detail that you can follow up later on. 😉

@nicklem nicklem enabled auto-merge (squash) November 27, 2023 10:04
@github-actions github-actions bot temporarily deployed to Netlify November 27, 2023 10:05 Inactive
@github-actions github-actions bot temporarily deployed to Netlify November 27, 2023 10:07 Inactive
@nicklem nicklem removed the don't merge Don't merge this pull request yet label Nov 27, 2023
@nicklem nicklem merged commit 1df321f into master Nov 27, 2023
7 of 8 checks passed
@nicklem nicklem deleted the ALA-697-doc-vs-code-plugin-open-pr-list branch November 27, 2023 10:13
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.

3 participants