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

OPENNLP-1594 Add stricter tests for Summarizer component #158

Merged

Conversation

mawiesne
Copy link
Contributor

@mawiesne mawiesne commented Jul 12, 2024

Change

  • adds further, stricter tests
  • clarifies, at API level, the semantics and constraints of parameters
  • separates tests so that each test class has a clear responsibility for its class under test
  • removes binary model files from test/resources folder
  • improves / enhances the JavaDoc further
  • updates Wordnet to version 2.4.0 (was 2.2.3)

Notes

  • Class coverage: 100%
  • Line coverage: 94%
  • Branch coverage: 83%

Tasks

Thank you for contributing to Apache OpenNLP.

In order to streamline the review of the contribution we ask you
to ensure the following steps have been taken:

For all changes:

  • Is there a JIRA ticket associated with this PR? Is it referenced
    in the commit message?

  • Does your PR title start with OPENNLP-XXXX where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character.

  • Has your PR been rebased against the latest commit within the target branch (typically main)?

  • Is your initial contribution a single, squashed commit?

For code changes:

  • Have you ensured that the full suite of tests is executed via mvn clean install at the root opennlp-sandbox folder?
  • Have you written or updated unit tests to verify your changes?
  • If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under ASF 2.0?
  • If applicable, have you updated the LICENSE file, including the main LICENSE file in opennlp-sandbox folder?
  • If applicable, have you updated the NOTICE file, including the main NOTICE file found in opennlp-sandbox folder?

For documentation related changes:

  • Have you ensured that format looks appropriate for the output in which it is rendered?

Note:

Please ensure that once the PR is submitted, you check GitHub Actions for build issues and submit an update to your PR as soon as possible.

@mawiesne mawiesne requested review from kinow, jzonthemtn and rzo1 July 12, 2024 15:27
@mawiesne mawiesne self-assigned this Jul 12, 2024
Copy link
Member

@kinow kinow left a comment

Choose a reason for hiding this comment

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

A few comments but no blockers! Thanks

@mawiesne mawiesne force-pushed the OPENNLP-1594-Add-stricter-tests-for-Summarizer-component branch from 976f251 to a56d613 Compare July 15, 2024 06:56
@mawiesne mawiesne requested a review from kinow July 15, 2024 06:56
- adds further, stricter tests
- clarifies, at API level, the semantics and constraints of parameters
- separates tests so that each test class has a clear responsibility for its class under test
- removes binary model files from test/resources folder
- improves / enhances the JavaDoc further
@mawiesne mawiesne force-pushed the OPENNLP-1594-Add-stricter-tests-for-Summarizer-component branch from a56d613 to b130395 Compare July 19, 2024 19:04
@mawiesne mawiesne merged commit c366052 into master Jul 19, 2024
6 checks passed
@mawiesne mawiesne deleted the OPENNLP-1594-Add-stricter-tests-for-Summarizer-component branch July 19, 2024 19:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants