Convert reports to Guice #803
Conversation
|
IMHO release notes should be limited to user visible changes. This isn't such. |
Every code changes, refactor and so can have an impact on users ... so should be listed in release notes, maybe on the and of other more important changes. |
|
Vote about migrating to GitHub issues passed so we could słowny, project by project move to GH Issues. Wdyt @elharo |
|
This PR probablly isn't the right place to discuss that, unless there's something more specific you wanted to ask? |
|
Yes, here we ask to register Jira. |
|
I think release notes, Jira (or Giithub) issues, and PRs are three independent things. There's no 1:1 relationship between them. Each should be written for its audience and purpose. Release notes are for users of the tool. Jira issues are mostly for current developers. PR descriptions are for future developers trying to understand the code. |
|
If yes, it would be good to have a similar understanding also described on our Maven site, as we have a plan to open reporting issues via gh. |
|
anyway - good job. |
| /** | ||
| * @return The according string for the section. | ||
| * @return the according string for the section |
There was a problem hiding this comment.
Do you want to use the Java 16 inline return Javadoc here (which automatically adds the period at the end)?
If yes, the correct Javadoc to write this would be
{@return the according string for the section}Which would be transformed to
Returns the according string for the section.
There was a problem hiding this comment.
No, per pom.xml we're still using Java 8 here
No description provided.