ALFMOB-317: Create Readme.md#71
Open
joaosamueldiogo-mindera wants to merge 8 commits into
Open
Conversation
Co-authored-by: Copilot <copilot@github.com>
Co-authored-by: Copilot <copilot@github.com>
silvaricMindera
previously approved these changes
May 13, 2026
silvaric
requested review from
silvaricMindera
and removed request for
silvaricMindera
silvaric
previously approved these changes
May 13, 2026
silvaric
requested review from
silvaric and
silvaricMindera
and removed request for
silvaricMindera
|
|
||
| This project uses the MVVM architecture model as reccommended by the [Flutter Documentation](https://docs.flutter.dev/app-architecture/guide). | ||
|
|
||
| ### View |
Contributor
There was a problem hiding this comment.
Think this and ViewModel aren't really needed as they are, a dev coming into the project should know that a view shouldn't have business logic or that a ViewModel represents the domain data to be used for the view
| - Executes `alfie_flutter/test_coverage.sh` to run tests and generate coverage. | ||
| - Optionally runs smoke integration tests on Android when enabled. | ||
| - Uploads LCOV coverage reports as a PR message. | ||
|
|
Contributor
There was a problem hiding this comment.
A couple of things I think we could add:
- Branch Naming convention
- Commit message convention
- PR rules (template)
- code reviews expectations
- Merging/Rebasing rules (something like we prefer merge over rebase)
- riverpod, with links to the documentation
We may not include every single one of these and some don't need much detail, but think they're useful when starting out in a project
@silvaric thoughts on these?
Co-authored-by: Copilot <copilot@github.com>
silvaric
requested review from
silvaric and
silvaricMindera
and removed request for
silvaric and
silvaricMindera
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Added a Readme.md file.
Why
In order to give a overview of project details and setup.
See
Link to JIRA: ALFMOB-317