application-services icon indicating copy to clipboard operation
application-services copied to clipboard

Improve the Suggest component's `README`.

Open linabutler opened this issue 1 year ago • 1 comments

Rendered

I wanted to add an architecture diagram, too, but I'm still learning Mermaid's syntax! :joy: Here's a start at some better documentation, though!

Pull Request checklist

  • Breaking changes: This PR follows our breaking change policy
    • [ ] This PR follows the breaking change policy:
      • This PR has no breaking API changes, or
      • There are corresponding PRs for our consumer applications that resolve the breaking changes and have been approved
  • [ ] Quality: This PR builds and tests run cleanly
    • Note:
      • For changes that need extra cross-platform testing, consider adding [ci full] to the PR title.
      • If this pull request includes a breaking change, consider cutting a new release after merging.
  • [ ] Tests: This PR includes thorough tests or an explanation of why it does not
  • [ ] Changelog: This PR includes a changelog entry in CHANGELOG.md or an explanation of why it does not need one
    • Any breaking changes to Swift or Kotlin binding APIs are noted explicitly
  • [ ] Dependencies: This PR follows our dependency management guidelines
    • Any new dependencies are accompanied by a summary of the due dilligence applied in selecting them.

Branch builds: add [firefox-android: branch-name] to the PR title.

linabutler avatar Feb 13 '24 02:02 linabutler

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 84.08%. Comparing base (01a52c7) to head (9717178).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #6127   +/-   ##
=======================================
  Coverage   84.08%   84.08%           
=======================================
  Files         117      117           
  Lines       15629    15629           
=======================================
  Hits        13141    13141           
  Misses       2488     2488           

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov-commenter avatar Feb 13 '24 02:02 codecov-commenter