Skip to content
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

Merged

Conversation

BlaineEXE
Copy link
Member

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:

  • Commit Message Formatting: Commit titles and messages follow guidelines in the developer guide.
  • Skip Tests for Docs: Add the flag for skipping the build if this is only a documentation change. See here for the flag.
  • Skip Unrelated Tests: Add a flag to run tests for a specific storage provider. See test options.
  • Reviewed the developer guide on Submitting a Pull Request
  • Documentation has been updated, if necessary.
  • Unit tests have been added, if necessary.
  • Integration tests have been added, if necessary.
  • Pending release notes updated with breaking and/or notable changes, if necessary.
  • Upgrade from previous release is tested and upgrade user guide is updated, if necessary.
  • Code generation (make codegen) has been run to update object specifications, if necessary.

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
Copy link
Member

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?

Copy link
Member Author

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?

Copy link
Member

@travisn travisn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just a nit

Documentation/development-flow.md Outdated Show resolved Hide resolved
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>
@BlaineEXE BlaineEXE force-pushed the emphaize-unit-tests-in-contributor-guides branch from eabf1d6 to dc3c84e Compare September 10, 2021 20:30
@leseb leseb merged commit 1df2e93 into rook:master Sep 13, 2021
travisn added a commit that referenced this pull request Sep 13, 2021
docs: emphasize unit tests in development guide (backport #8685)
@BlaineEXE BlaineEXE deleted the emphaize-unit-tests-in-contributor-guides branch September 14, 2021 18:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants