-
Notifications
You must be signed in to change notification settings - Fork 927
Update Readme compatibility docs #6100
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
Conversation
|
Claude finished @david-livefront's task —— View job Review CompleteTasks
Summary of ChangesThis PR updates compatibility documentation across 7 README files, standardizing the format to include Android version names alongside SDK numbers. It also relocates the Authenticator README from the root directory ( Changes:
Critical IssuesNone found. The changes are documentation-only and accurately reflect the current SDK configuration in Suggested Improvements1. Incorrect header in ui/README.mdFile: The UI module's README has an incorrect header that reads "Data module" instead of "UI module": # Data module
An Android library containing common UI components, types, and utilities.This should be: # UI module
An Android library containing common UI components, types, and utilities.Note: This is a pre-existing issue, not introduced by this PR, but should be fixed. ❓ Question: Repository URL mismatch in Authenticator READMEFile: The cloning instructions reference $ git clone https://github.com/bitwarden/authenticator-androidHowever, this file is now in the $ git clone https://github.com/bitwarden/androidOr is the separate 💭 Consideration: GitHub Actions badge in Authenticator READMEFile: The README references a workflow from a different repository: [](https://github.com/bitwarden/authenticator-android/actions/workflows/build-authenticator.yml?query=branch:main)If the authenticator is now fully integrated into this monorepo, this badge may need updating to reference the correct repository and workflow. Good Practices Observed
Action ItemsFor this PR:
Follow-up items (optional):
|
|
Great job! No new security vulnerabilities introduced in this pull request |
|
Thanks @SaintPatrck |
1907f45 to
deadb84
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #6100 +/- ##
=======================================
Coverage 84.81% 84.81%
=======================================
Files 721 721
Lines 52811 52811
Branches 7668 7668
=======================================
Hits 44791 44791
Misses 5328 5328
Partials 2692 2692 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|

🎟️ Tracking
N/A
📔 Objective
This PR updates the compatibility documentation and moves the Authenticator Readme to the authenticator module.
⏰ Reminders before review
🦮 Reviewer guidelines
:+1:) or similar for great changes:memo:) or ℹ️ (:information_source:) for notes or general info:question:) for questions:thinking:) or 💭 (:thought_balloon:) for more open inquiry that's not quite a confirmed issue and could potentially benefit from discussion:art:) for suggestions / improvements:x:) or:warning:) for more significant problems or concerns needing attention:seedling:) or ♻️ (:recycle:) for future improvements or indications of technical debt:pick:) for minor or nitpick changes