docs: snapshot versions

[jo-elimu]

Issue Number

• Resolves Document how to use mavenLocal() with utils libraries #211

Purpose

Technical Details

Screenshots

Testing Instructions

Regression Tests

• I tested my changes on Android 15 (API 35)
• I tested my changes on Android 14 (API 34)
• I tested my changes on Android 13 (API 33)
• I tested my changes on Android 12L (API 32)
• I tested my changes on Android 12 (API 31)
• I tested my changes on Android 11 (API 30)
• I tested my changes on Android 10 (API 29)
• I tested my changes on Android 9 (API 28)
• I tested my changes on Android 8.1 (API 27)
• I tested my changes on Android 8.0 (API 26)

UI Tests

• I tested my changes on a 6-7" screen (▯ portrait orientation)
• I tested my changes on a 6-7" screen (▭ landscape orientation)
• I tested my changes on a 7-8" screen (▯ portrait orientation)
• I tested my changes on a 7-8" screen (▭ landscape orientation)
• I tested my changes on a 9-10" screen (▯ portrait orientation)
• I tested my changes on a 9-10" screen (▭ landscape orientation)

Summary by CodeRabbit

• Documentation
  • Overhauled and reorganized the instructions for testing snapshot releases during local development.
  • Introduced a detailed, step-by-step guide complete with practical code examples.
  • Updated versioning details to reflect the latest snapshot release, enhancing clarity and ease of use for testing the library locally.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request updates the README.md to provide a detailed guide on testing -SNAPSHOT versions of the utils library. The documentation now includes a step-by-step procedure for modifying the build.gradle files by adding mavenLocal(), publishing the library to the local Maven repository, and updating the app’s dependencies. Additionally, the version number has been updated from model-1.2.38 to model-1.2.39-SNAPSHOT, with new code snippets enhancing clarity.

Changes

File(s)	Change Summary
README.md	Restructured the section on publishing snapshots by adding a new detailed guide titled "How to Test -SNAPSHOT Versions of the Utils Library." Instructions now include modifications to build.gradle files (adding mavenLocal()), publishing steps, and a version update from model-1.2.38 to model-1.2.39-SNAPSHOT with accompanying code snippets.

Assessment against linked issues

Objective	Addressed	Explanation
Document how to use mavenLocal() with utils libraries (#211)	✅

Possibly related PRs

• Document how to publish utils module to local maven repository #179: Addresses similar modifications pertaining to publishing the utils library to a local Maven repository, including necessary build.gradle updates.

Suggested reviewers

• tuancoltech

elimu.ai's mission is to build innovative learning software that empowers out-of-school children to teach themselves basic reading📖, writing✍🏽 and math🔢 within 6 months.

---

📜 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 d466734 and e6c58c3.

📒 Files selected for processing (1)

• README.md (1 hunks)

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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.