[Mobile App] #809: Move the App Testing Documentation from Google Docs to the app repository

[KarinBerg]

• I moved the content from the Google Docs App Testing Guide to a new directory "docu" in the repository.
• I also created a rudimentary "How to release" guide
• Further more I adjusted and updated some other MARKDOWN files

This is just a rudimentary starting point and will be enhanced with the time.

Summary by CodeRabbit

• Documentation
  • Updated CONTRIBUTING.md with a new stage build flavor for staging Firebase project
  • Enhanced README.md with improved testing section and formatting
  • Added comprehensive documentation for app release and testing processes
  • Created new test environments guide detailing DEV, STAGING, and PROD stages
  • Introduced detailed manual test plans covering various app functionalities

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
public	⬜️ Ignored (Inspect)	Visit Preview		Sep 27, 2024 4:23pm

[ssandino]

Great!

[coderabbitai]

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

This pull request introduces comprehensive documentation updates for the recipients app, focusing on testing environments, release processes, and development guidelines. The changes include adding new markdown files for test environments, manual testing plans, and release procedures. A new staging build flavor is introduced, and documentation is enhanced to provide clearer guidance for developers and testers on app development, testing, and release workflows.

Changes

File	Change Summary
recipients_app/CONTRIBUTING.md	Updated terminology from "iPhones" to "iOS"; Added new stage build flavor for staging Firebase project
recipients_app/README.md	Added new "Testing" section with golden file update instructions
recipients_app/docu/app_release_guides/releasing.md	Comprehensive guide for app release process for iOS and Android
recipients_app/docu/app_testing_guides/how_to_test.md	New section on release testing process
recipients_app/docu/app_testing_guides/manual_test_plans.md	Detailed manual testing guide for app functionalities
recipients_app/docu/app_testing_guides/test_environments.md	New document describing DEV, STAGING, and PROD testing environments

Sequence Diagram

sequenceDiagram
    participant Dev as Developer
    participant Stage as Staging Environment
    participant Prod as Production Environment
    
    Dev->>Stage: Configure stage build flavor
    Dev->>Stage: Run tests
    alt Tests Successful
        Dev->>Prod: Prepare release
        Dev->>Prod: Submit to App Store/Play Store
    else Tests Failed
        Dev->>Dev: Fix bugs
    end

Loading

Possibly Related PRs

• [Mobile App] Add documentation about need tools and versions to build our app #963: Adds documentation about build tools and versions
• [Mobile App] Update to flutter 3.22.3 and packages #964: Updates Flutter version in .tool-versions
• [Mobile App] 989: Update Flutter SDK and packages, Xcode, Android Gradle #991: Updates Flutter SDK and packages

Suggested Reviewers

• andrashee
• mkue
• MDikkii
• novas1r1
• ssandino

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7357858 and 0c82737.

📒 Files selected for processing (6)

• recipients_app/CONTRIBUTING.md (2 hunks)
• recipients_app/README.md (1 hunks)
• recipients_app/docu/app_release_guides/releasing.md (1 hunks)
• recipients_app/docu/app_testing_guides/how_to_test.md (1 hunks)
• recipients_app/docu/app_testing_guides/manual_test_plans.md (1 hunks)
• recipients_app/docu/app_testing_guides/test_environments.md (1 hunks)

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.