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

Add Nested annotation in Demo where it's missing #777

Closed
wants to merge 1 commit into from

Conversation

IlyasYOY
Copy link
Contributor

@IlyasYOY IlyasYOY commented Oct 18, 2023

Added Nested annotations where they seemed to be missing. Ran tests to be sure the fix didn't introduced failing tests.

I was going through demo classes and found some nested tests not marked Nested. I thought that not using Nested annotation might get stale.

open problems:

  • There are still some tests that are didn't manage to get running.
  • I didn't include myself in Contributing, because change is really minor.
  • Those tests might have been better off w/o Nested.
  • I think that we also missing Test here.

PR checklist

The following checklist shall help the PR's author, the reviewers and maintainers to ensure the quality of this project.
It is based on our contributors guidelines, especially the "writing code" section.
It shall help to check for completion of the listed points.
If a point does not apply to the given PR's changes, the corresponding entry can be simply marked as done.

Documentation (general)

  • [-] There is documentation (Javadoc and site documentation; added or updated)
  • There is implementation information to describe why a non-obvious source code / solution got implemented
  • [-] Site documentation has its own .adoc file in the docs folder, e.g. docs/report-entries.adoc
  • [-] Site documentation in .adoc file references demo in src/demo/java instead of containing code blocks as text
  • [-] Only one sentence per line (especially in .adoc files)
  • [-] Javadoc uses formal style, while sites documentation may use informal style

Documentation (new extension)

  • [-] The docs/docs-nav.yml navigation has an entry for the new extension
  • [-] The package-info.java contains information about the new extension

Code (general)

  • Code adheres to code style, naming conventions etc.
  • Successful tests cover all changes
  • There are checks which validate correct / false usage / configuration of a functionality and there are tests to verify those checks
  • Tests use AssertJ or our own PioneerAssert (which are based on AssertJ)

Code (new package)

  • [-] The new package is exported in module-info.java
  • [-] The new package is also present in the tests
  • [-] The new package is opened for reflection to JUnit 5 in module-info.java
  • [-] The new package is listed in the contribution guide

Contributing

  • A prepared commit message exists
  • [-] The list of contributions inside README.md mentions the new contribution (real name optional)

@IlyasYOY IlyasYOY marked this pull request as ready for review October 20, 2023 16:16
@Michael1993 Michael1993 changed the title Add Nested annotation in Demo where its probable missing Add Nested annotation in Demo where it's missing Oct 24, 2023
@Michael1993
Copy link
Member

This is a great catch. We really don't pay enough attention to the demo tests. 😅

I don't think there are contributions that are 'too small', so if you would like to add yourself as a contributor feel free to do so!

@beatngu13 beatngu13 added the full-build Triggers full build suite on PR label Oct 29, 2023
Added Nested annotations where they seemed to be missing. Ran tests to
be sure the fix didn't introduced failing tests.
@IlyasYOY
Copy link
Contributor Author

IlyasYOY commented Oct 29, 2023

I don't think there are contributions that are 'too small', so if you would like to add yourself as a contributor feel free to do so!

Added myself as contributor. I'll try to help with more issues.

Thank you for this library!

@nipafx
Copy link
Member

nipafx commented Nov 9, 2023

Thank you @IlyasYOY for the PR, this is really neat! The demos need more attention and we appreciated you gave it some. ❤️

I added some local changes, but it looks like I can't push to your branch. Maybe because it's the main branch? In the future, please create a new branch for your contributions - see the contribution guide for details.

I will open a new PR with these changes, so I can add mine and merge it. Thanks again! 😃

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
full-build Triggers full build suite on PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants