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
docs: emphasize unit tests in development guide #8685
docs: emphasize unit tests in development guide #8685
Conversation
Once you have implemented the feature or bug fix in your branch, you will open a PR to the upstream rook repo. Before opening the PR ensure you have added unit tests, are passing the integration tests, cleaned your commit history, and have rebased on the latest upstream. | ||
Once you have implemented the feature or bug fix in your branch, you will open a Pull Request (PR) | ||
to the [upstream Rook repository](https://github.com/rook/rook). Before opening the PR ensure you | ||
have added unit tests and all unit tests are passing. Please clean your commit history and rebase on |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add an indication on how to run the unit test with make
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is a link to the section below good?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
just a nit
Emphasize unit tests in the development guide, and provide guidelines to help contributors create good unit tests. Also clarify that Rook's CI will run integration tests and that users aren't expected to run integration tests locally. Signed-off-by: Blaine Gardner <blaine.gardner@redhat.com>
eabf1d6
to
dc3c84e
Compare
docs: emphasize unit tests in development guide (backport #8685)
Emphasize unit tests in the development guide, and provide guidelines to
help contributors create good unit tests.
Also clarify that Rook's CI will run integration tests and that users
aren't expected to run integration tests locally.
Signed-off-by: Blaine Gardner blaine.gardner@redhat.com
Description of your changes:
Which issue is resolved by this Pull Request:
Resolves #
Checklist:
make codegen
) has been run to update object specifications, if necessary.