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

Document README files #312

Merged
merged 9 commits into from
Jan 11, 2024
Merged

Document README files #312

merged 9 commits into from
Jan 11, 2024

Conversation

microstudi
Copy link
Contributor

@microstudi microstudi commented Dec 20, 2023

Document readmes for the included gems.

fixes #246

Copy link
Member

@andreslucena andreslucena left a comment

Choose a reason for hiding this comment

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

Great improvement, I only have a few minor details and this is ready

bulletin_board/ruby-client/README.md Outdated Show resolved Hide resolved
bulletin_board/ruby-client/README.md Outdated Show resolved Hide resolved
bulletin_board/ruby-client/README.md Outdated Show resolved Hide resolved
bulletin_board/ruby-client/README.md Outdated Show resolved Hide resolved
bulletin_board/server/README.md Outdated Show resolved Hide resolved
@microstudi
Copy link
Contributor Author

Changes applied @andreslucena

Copy link
Member

@andreslucena andreslucena left a comment

Choose a reason for hiding this comment

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

A couple more details and we're good

bulletin_board/ruby-client/README.md Outdated Show resolved Hide resolved
bulletin_board/ruby-client/README.md Outdated Show resolved Hide resolved
bulletin_board/ruby-client/README.md Outdated Show resolved Hide resolved
bulletin_board/ruby-client/README.md Outdated Show resolved Hide resolved
bulletin_board/ruby-client/README.md Outdated Show resolved Hide resolved
microstudi and others added 5 commits January 11, 2024 15:12
Co-authored-by: Andrés Pereira de Lucena <[email protected]>
Co-authored-by: Andrés Pereira de Lucena <[email protected]>
Co-authored-by: Andrés Pereira de Lucena <[email protected]>
Co-authored-by: Andrés Pereira de Lucena <[email protected]>
Co-authored-by: Andrés Pereira de Lucena <[email protected]>
@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (be58cb5) 69.57% compared to head (38a8f4d) 69.57%.
Report is 1 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop     #312   +/-   ##
========================================
  Coverage    69.57%   69.57%           
========================================
  Files           96       96           
  Lines         1630     1630           
========================================
  Hits          1134     1134           
  Misses         496      496           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@andreslucena
Copy link
Member

There's a failing spec for a linter but that's already happening in the develop branch, so I'm merging this

@andreslucena andreslucena merged commit b80e7e3 into develop Jan 11, 2024
11 of 12 checks passed
@andreslucena andreslucena deleted the readmes branch January 11, 2024 14:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document README.md for gems
4 participants