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: Simplified CS creation flow ALA-940 #2074

Draft
wants to merge 10 commits into
base: master
Choose a base branch
from

Conversation

nicklem
Copy link
Contributor

@nicklem nicklem commented Apr 5, 2024

❗ WIP

Documents the new, simplified coding standard creation flow.

👀 Live preview

https://ala-940-docs-document-simplified-cs--docs-codacy.netlify.app/organizations/using-coding-standards/

🚧 To do

  • Fix all in-code TODOs
  • Audit docs for stray mentions of the old flow
  • Audit docs for old screenshots
    • In particular, consider the new placement of the CS rename box (see ALA-961)

@github-actions github-actions bot temporarily deployed to Netlify April 5, 2024 15:33 Inactive
Copy link
Contributor

github-actions bot commented Apr 5, 2024

Overall readability score: 53.82 (🔴 -0.01)

File Readability
using-coding-standards.md 60.46 (🔴 -1.69)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
using-coding-standards.md 60.46 39.23 8.94 12.2 13.33 6.49
  🔴 -1.69 🟢 +0 🔴 -0.16 🔴 -0.3 🔴 -0.4 🔴 -0.13

Averages:

  Readability FRE GF ARI CLI DCRS
Average 53.82 42.55 10.89 12.45 12.56 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

@nicklem nicklem self-assigned this Apr 5, 2024
@nicklem nicklem added the don't merge Don't merge this pull request yet label Apr 5, 2024
@nicklem nicklem changed the title feat: IA and TODOs feat: Simplified CS creation flow Apr 8, 2024
@nicklem nicklem changed the title feat: Simplified CS creation flow feat: Simplified CS creation flow ALA-940 Apr 8, 2024
@github-actions github-actions bot temporarily deployed to Netlify April 8, 2024 12:59 Inactive
@github-actions github-actions bot temporarily deployed to Netlify April 10, 2024 13:05 Inactive
@github-actions github-actions bot temporarily deployed to Netlify April 10, 2024 13:27 Inactive
@github-actions github-actions bot temporarily deployed to Netlify April 11, 2024 13:34 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.

Looks very good, @nicklem! 👌
I like the way you reorganized the content to fit the advanced settings. 👍

I left some comments for your evaluation.

docs/organizations/using-coding-standards.md Outdated Show resolved Hide resolved
docs/organizations/using-coding-standards.md Outdated Show resolved Hide resolved
docs/organizations/using-coding-standards.md Outdated Show resolved Hide resolved
docs/organizations/using-coding-standards.md Outdated Show resolved Hide resolved
docs/organizations/using-coding-standards.md Outdated Show resolved Hide resolved
docs/organizations/using-coding-standards.md Outdated Show resolved Hide resolved
docs/organizations/using-coding-standards.md Outdated Show resolved Hide resolved
- To toggle multiple code patterns at once, click the checkbox of the first pattern and **Shift+click** the checkbox of the last pattern in a range.
- To toggle all the code patterns visible on the list, click the checkbox on the header of the code patterns list. If there are more code patterns to load on the list, you can click the link **Enable/Disable all <N> patterns** to toggle all patterns matching the current filters.

![Configuring the tools and patterns for the coding standard](images/coding-standard-configure-tools.png)<1-- TODO ALA-940 screenshot -->

## Defining a default coding standard {: id="set-default"}
Copy link
Contributor

Choose a reason for hiding this comment

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

We could mention (maybe here) the option to set a coding standard as default during when creating the it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sorry, the link doesn't work after I pushed some updates. Where did you suggest that we mention it?

Copy link
Contributor

Choose a reason for hiding this comment

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

Somewhere near this line:
To set a coding standard as default:

(GitHub didn't allow me to add that note on the specific line because it wasn't new content... 😉 )

docs/organizations/using-coding-standards.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 24, 2024 12:56 Inactive
@github-actions github-actions bot temporarily deployed to Netlify April 24, 2024 14:18 Inactive
@github-actions github-actions bot temporarily deployed to Netlify May 8, 2024 11:00 Inactive
@github-actions github-actions bot temporarily deployed to Netlify May 9, 2024 07:10 Inactive
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
don't merge Don't merge this pull request yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants