Skip to content

Docs: Add guidelines for tests #16784

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.

Sign up for GitHub

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

Open
ebyhr wants to merge 1 commit into
base: main
Choose a base branch
from
+6 −0
Open

Docs: Add guidelines for tests #16784

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions site/docs/contribute.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -478,6 +478,12 @@ This helps separate logical sections of the code, making it easier to read and d

## Testing

### Conventions and recommendations

- Test class names must start with `Test`, for example `TestExample`.
- Recommend omitting the `public` modifier for test classes, test methods, and lifecycle methods.
- Recommend omitting the `test` prefix for test methods.

### AssertJ

Prefer using [AssertJ](https://github.com/assertj/assertj) assertions as those provide a rich and intuitive set of strongly-typed assertions.
Expand Down