From bb47d8e87eea829a521d0691dafeefebb8ae2a34 Mon Sep 17 00:00:00 2001 From: Gergely Hegedus Date: Thu, 14 Jul 2022 11:27:22 +0300 Subject: [PATCH] Create Dev Readme about actions and structures --- DEV.README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 DEV.README.md diff --git a/DEV.README.md b/DEV.README.md new file mode 100644 index 0000000..9010939 --- /dev/null +++ b/DEV.README.md @@ -0,0 +1,27 @@ +# About contributing into the project and structure +These are notes to myself what the project has currently and how to do verifications. + +## Pull Request + +Each pull request must be go though the automated CI checks, which are: +- Static Code Analyisis (detekt, ktlint, lint) +- JVM Tests (unit tests + Robolectric Tests) +- Android Tests on Emulators + +This is to ensure the project is still working after every merge. + +## Verifications of Screenshot Pulling + +A Manual Action has been created to verify the ScreenshotRule with the Gradle script is able to pull screenshots from the Device. +This can be run in Actions/Verify Screenshots can be created and pulled/Run Workflow + +This should be tested on newer Emulators time to time. + +## Libraries +Libraries are util classes for Testing. +This can be released into packages by simply creating a Release from the Project. That will trigger an Action which publishes to GitHub Packages. + +## Modifications to Tests + +Each modifications to tests should also modify the corresponding section if applicable. +This to ensure whoever wants to learn, won't get stuck by inconsistency between the code and description.