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

Improve README.md Noticeability #1405

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

Jaehwa-Noh
Copy link
Contributor

@Jaehwa-Noh Jaehwa-Noh commented Apr 27, 2024

What I have done and why

Highlighted Note in README.md to improve noticeability.
You can see the preview in here

Note

You should not run ./gradlew test or ./gradlew connectedAndroidTest as this will execute
tests against all build variants which is both unecessary and will result in failures as only the
demoDebug variant is supported. No other variants have any tests (although this might change in future).

Note

The known correct screenshots stored in this repository are recorded on CI using Linux. Other
platforms may (and probably will) generate slightly different images, making the screenshot tests fail.
When working on a non-Linux platform, a workaround to this is to run recordRoborazziDemoDebug on the
main branch before starting work. After making changes, verifyRoborazziDemoDebug will identify only
legitimate changes.

Note

The baseline profile needs to be re-generated for release builds that touch code which changes app startup.

How I'm testing it

Choose at least one:

  • Unit tests
  • UI tests
  • Screenshot tests
  • N/A (provide justification)

Change-Id: I79b564cf56428dd278d257da2c75f57312067148
Change-Id: I9ec8e49a3fcd88de9de1838b3003ed81150d4cf6
@Jaehwa-Noh Jaehwa-Noh changed the title Highlight Note in README.md Improve README.md Noticeability May 3, 2024
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

1 participant