Add Unit Testing Guidelines to CONTRIBUTING.md for Scribe Android
#228
Conversation
Thank you for the pull request!The Scribe team will do our best to address your contribution as soon as we can. The following is a checklist for maintainers to make sure this process goes as well as possible. Feel free to address the points below yourself in further commits if you realize that actions are needed :) If you're not already a member of our public Matrix community, please consider joining! We'd suggest using Element as your Matrix client, and definitely join the General and Android rooms once you're in. Also consider joining our bi-weekly Saturday dev syncs. It'd be great to have you! Maintainer checklist |
CONTRIBUTING.md
Outdated
| } | ||
| ``` | ||
|
|
||
| - **Mocking**: Use mocks (e.g., Mockito) to isolate the unit under test, especially with dependencies like databases, network requests, or services. |
There was a problem hiding this comment.
This project is setup with MockK so I recommend referring to that instead of Mockito
CONTRIBUTING.md
Outdated
| - **Comments**: Add comments when test logic is complex or non-intuitive. | ||
| - **Assertions**: Use descriptive assertion methods (`assertTrue`, `assertEquals`, etc.) for clarity and include failure messages for custom assertions if necessary. | ||
|
|
||
| Following these conventions ensures consistent, readable, and reliable unit tests, enhancing the quality of the Scribe Android codebase. |
There was a problem hiding this comment.
It's good to highlight the importance of testing but this is very similar to the opening content of this section and could be removed. The shorter the docs are, the more likely people are to finish reading through them.
CONTRIBUTING.md
Outdated
|
|
||
| #### 1. Project Structure for Unit Tests | ||
|
|
||
| - **Location**: Place all unit tests in the `src/test/java` directory, mirroring the structure of the `src/main/java` directory. For new classes or features, ensure their corresponding test classes follow the same package structure. |
There was a problem hiding this comment.
This must be an Android project structure thing - I'm newer to Android - why is kotlin code put under java directories?
The unit tests I added as an example are under src/test/kotlin so a follow up will need to be moving the example to the correct structure if src/test/java is the desired structure.
| - **Class Files**: Each class in `src/main/java` should have a dedicated test file in `src/test/java`, named by appending `Test` to the class name (e.g., `UserManager` → `UserManagerTest`). | ||
| - **New Classes for Testing**: When a new utility or helper class is needed specifically for testing, place it under `src/test/java/utils` or `src/test/java/helpers`. | ||
|
|
||
| #### 2. Naming Conventions for Tests |
There was a problem hiding this comment.
Thank you for adding examples in this section
There was a problem hiding this comment.
Thanks for the contribution, @KesharwaniArpita :) This will definitely come in handy as we expand out the testing of the project.
Contributor checklist
./gradlew lintKotlin detekt testcommand as directed in the testing section of the contributing guideDescription
This PR enhances the CONTRIBUTING.md file by adding comprehensive unit testing guidelines for the Scribe Android project. The added section provides structured guidance on writing, organizing, and naming unit tests, with best practices that will improve test consistency, readability, and effectiveness across the codebase.
Key Changes:
Importance of Unit Testing:
Project Structure:
Naming Conventions:
Scope and Focus:
Writing Effective Tests:
Documentation for Tests:
Motivation:
These conventions will help maintain a high standard of testing in the Scribe Android codebase, providing clarity for both current and new contributors and reducing maintenance overhead over time.
CC: @albendz Please review the added conventions and suggest any adjustments if needed.
Related issue