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

Merged
merged 20 commits into from
May 29, 2024

Conversation

nicklem
Copy link
Contributor

@nicklem nicklem commented Apr 5, 2024

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: 54.08 (🔴 -0.01)

File Readability
using-coding-standards.md 60.5 (🔴 -1.5)
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.5 39.23 8.98 12.2 13.39 6.43
  🔴 -1.5 🟢 +0 🔴 -0.11 🔴 -0.3 🔴 -0.46 🔴 -0.07

Averages:

  Readability FRE GF ARI CLI DCRS
Average 54.08 43.1 10.8 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
docs/organizations/using-coding-standards.md Show resolved Hide resolved
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
@github-actions github-actions bot temporarily deployed to Netlify May 10, 2024 13:59 Inactive
@github-actions github-actions bot temporarily deployed to Netlify May 10, 2024 14:35 Inactive
Copy link
Contributor

codacy-production bot commented May 27, 2024

  • item 1: description of change
  • item 2: description of change
  • ...

summary concluding sentence

EXAMPLE

feat: Simplified CS creation flow ALA-940

This pull request introduces a simplified flow for creating a coding standard in an organization.

  • New images for the coding standard creation process
  • Added an option to set the new coding standard as the default for the organization
  • Added an advanced settings page for fine-tuning the coding standard

The new images make the coding standard creation process clearer and more intuitive. The added option to set the new coding standard as the default for the organization simplifies the process for new repositories. The advanced settings page allows for more precise control over the coding standard.


This comment was generated by an experimental AI tool (winner of the 2024 Codacy Hackathon 'People's Choice' and 'Most Valuable' awards).

@github-actions github-actions bot temporarily deployed to Netlify May 27, 2024 13:32 Inactive
@github-actions github-actions bot temporarily deployed to Netlify May 28, 2024 09:39 Inactive
@github-actions github-actions bot temporarily deployed to Netlify May 28, 2024 10:23 Inactive
@nicklem nicklem marked this pull request as ready for review May 28, 2024 10:26
@nicklem nicklem requested a review from a team as a code owner May 28, 2024 10:26
@nicklem nicklem requested a review from a team May 28, 2024 10:26
@github-actions github-actions bot temporarily deployed to Netlify May 28, 2024 10:31 Inactive
Copy link
Member

@machadoit machadoit left a comment

Choose a reason for hiding this comment

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

LGTM! 👌

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 two small adjustments.

docs/organizations/using-coding-standards.md Outdated Show resolved Hide resolved
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 May 28, 2024 10:58 Inactive
@nicklem nicklem removed the don't merge Don't merge this pull request yet label May 29, 2024
@github-actions github-actions bot temporarily deployed to Netlify May 29, 2024 10:27 Inactive
@nicklem nicklem enabled auto-merge (squash) May 29, 2024 10:37
@nicklem nicklem disabled auto-merge May 29, 2024 10:38
@github-actions github-actions bot temporarily deployed to Netlify May 29, 2024 10:39 Inactive
@nicklem nicklem merged commit 37704d8 into master May 29, 2024
6 checks passed
@nicklem nicklem deleted the ALA-940-docs-document-simplified-cs-creation-flow branch May 29, 2024 10:41
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