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

docs: readme refactoring #1996

Merged
merged 22 commits into from
Oct 11, 2023

Conversation

DavideMininni-Fincons
Copy link
Contributor

@DavideMininni-Fincons DavideMininni-Fincons commented Sep 21, 2023

Preflight Checklist

Issue

This PR Closes #1977

Pull request checklist

Please check if your PR fulfills the following requirements:

  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been reviewed and added / updated if needed (for bug fixes / features)

See Review Guidelines for more information what is checked during review process.

Changes

Changes in this pull request:

  • the readme.md in the boilerplate folder has been revisited adding paragraphs;
  • the CODING_STANDARD.md has been updated;
  • all the readme.md files, except for the internals/timetable, has been refactored using paragraphs.

Browsers

I tested the build on the following browsers:

  • Firefox Desktop
  • Chrome Desktop
  • Edge Desktop
  • Safari Desktop
  • Chrome Mobile
  • Safari Mobile

Screen readers

I tested the build on the following browsers:

  • JAWS Firefox Desktop
  • JAWS Chrome Desktop
  • NVDA Firefox Desktop
  • NVDA Chrome Desktop
  • VoiceOver Safari Desktop
  • VoiceOver Chrome Desktop
  • VoiceOver Safari Mobile
  • Android Accessibility Suite Chrome Mobile

Pull request type

Please check the type of change your PR introduces:

  • Bugfix
  • Feature
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • Documentation content changes
  • Other (please describe):

Does this introduce a breaking change?

  • Yes
  • No

Other information

@DavideMininni-Fincons DavideMininni-Fincons changed the title docs: readmes refactoring docs: readme refactoring Sep 21, 2023
@github-actions github-actions bot temporarily deployed to preview-pr1996 September 21, 2023 14:00 Inactive
@github-actions github-actions bot temporarily deployed to preview-pr1996 September 22, 2023 08:05 Inactive
@codecov-commenter
Copy link

codecov-commenter commented Sep 22, 2023

Codecov Report

Merging #1996 (b9de383) into master (ab917b0) will decrease coverage by 18.13%.
Report is 1748 commits behind head on master.
The diff coverage is 30.55%.

❗ Current head b9de383 differs from pull request most recent head 248a60c. Consider uploading reports for the commit 248a60c to get more accurate results

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

@@             Coverage Diff             @@
##           master    #1996       +/-   ##
===========================================
- Coverage   54.85%   36.72%   -18.13%     
===========================================
  Files          49      288      +239     
  Lines        1659    10865     +9206     
  Branches      406     2382     +1976     
===========================================
+ Hits          910     3990     +3080     
- Misses        671     6617     +5946     
- Partials       78      258      +180     
Files Coverage Δ
...c/components/sbb-action-group/sbb-action-group.tsx 100.00% <100.00%> (ø)
...mponents/sbb-alert-group/sbb-alert-group.events.ts 100.00% <100.00%> (ø)
src/components/sbb-alert/sbb-alert.events.ts 100.00% <100.00%> (ø)
...onents/sbb-autocomplete/sbb-autocomplete.events.ts 100.00% <ø> (ø)
src/components/sbb-card-badge/sbb-card-badge.tsx 100.00% <100.00%> (+11.11%) ⬆️
src/components/sbb-card/sbb-card.stories.tsx 0.00% <ø> (ø)
src/components/sbb-card/sbb-card.tsx 90.00% <ø> (ø)
.../sbb-checkbox-group/sbb-checkbox-group.stories.tsx 0.00% <ø> (ø)
...mponents/sbb-checkbox-group/sbb-checkbox-group.tsx 33.33% <ø> (ø)
src/components/sbb-checkbox/sbb-checkbox.events.ts 0.00% <ø> (ø)
... and 55 more

... and 239 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

Copy link
Contributor

@dauriamarco dauriamarco left a comment

Choose a reason for hiding this comment

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

LGTM 👍 just a couple of comments.

src/components/sbb-card/readme.md Outdated Show resolved Hide resolved
@DavideMininni-Fincons DavideMininni-Fincons force-pushed the docs/use-subtitles-to-improve-readmes branch from b9de383 to f6cc8a8 Compare October 10, 2023 08:43
@DavideMininni-Fincons DavideMininni-Fincons merged commit 95bb0d5 into master Oct 11, 2023
@DavideMininni-Fincons DavideMininni-Fincons deleted the docs/use-subtitles-to-improve-readmes branch October 11, 2023 08:05
jeripeierSBB pushed a commit that referenced this pull request Oct 11, 2023
(cherry picked from commit 95bb0d5)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants