-
Notifications
You must be signed in to change notification settings - Fork 2
MS-1291 Add baseline copilot instructions in SID #1524
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
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| 1. Code Style | ||
|
|
||
| * Code follows general Kotlin code style recommendations. | ||
| * Use Android Jetpack ViewModel for managing UI-related data and use viewModelScope for coroutines. | ||
| * Use LiveData for observing and updating UI state. Use Custom event wrappers `LiveDataEventWithContent` to handle one-time events. | ||
| * Use delegates like `FragmentViewBindingDelegate` to simplify view binding in fragments. | ||
|
|
||
| 2. Architecture Layers: | ||
|
|
||
| * Feature Modules: Manages UI components and ViewModels as well as UI-dependant features. Implemented in `:feature` subfolder. | ||
|
luhmirin-s marked this conversation as resolved.
|
||
| * Infra Modules: Contains use cases and core business logic. Implemented in `:infra` subfolder. | ||
|
luhmirin-s marked this conversation as resolved.
|
||
| * Modality Modules: Contain business subsets of feature and infra modules related to a specific biometric modality. Implemented in `:face` | ||
| and `:fingerprint` subfolder. | ||
| * Each layer is isolated. Feature modules depend on other features and infra modules, infra modules only depend on other infra modules. | ||
|
luhmirin-s marked this conversation as resolved.
|
||
|
|
||
| 3. Dependency Injection: | ||
|
|
||
| * Use Dagger Hilt for dependency injection with the `@Inject` constructor as the preferred method of injection. | ||
| * Use Singleton scope (`@Singleton`) for critical dependencies. | ||
| * ViewModels are injected using Hilt (`@HiltViewModel`). | ||
|
|
||
| 4. Unit testing rules: | ||
|
|
||
|
meladRaouf marked this conversation as resolved.
|
||
| * Use JUnit 4 for unit testing, MockK for mocking, Google Truth for assertions, AndroidX Test for Android-specific testing. | ||
| * Test classes use the `*Test` suffix. Test methods use descriptive names with backticks. | ||
| * Setup logic is in `@Before` methods. Tests use `@RunWith(AndroidJUnit4::class)` where appropriate. Coroutine tests use `runTest { ... }`. | ||
| * Use Given-When-Then structure. Keep tests concise and focused. Use relaxed mocks to reduce boilerplate. | ||
| * Use helper methods for mock objects or test data. | ||
| * Use lifecycle-aware and coroutine testing where appropriate. | ||
| * Isolate Android framework dependencies unless required. | ||
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
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.
Uh oh!
There was an error while loading. Please reload this page.