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

Improve build (fix warnings and javadoc) #536

Merged
merged 6 commits into from
Mar 15, 2020
Merged

Conversation

nedtwigg
Copy link
Member

@nedtwigg nedtwigg commented Mar 5, 2020

Please make sure that your PR allows edits from maintainers. Sometimes its faster for us to just fix something than it is to describe how to fix it.

Allow edits from maintainers

After creating the PR, please add a commit that adds a bullet-point under the -SNAPSHOT section of CHANGES.md, plugin-gradle/CHANGES.md, and plugin-maven/CHANGES.md which includes:

  • a summary of the change
  • either
    • a link to the issue you are resolving (for small changes)
    • a link to the PR you just created (for big changes likely to have discussion)

If your change only affects a build plugin, and not the lib, then you only need to update the CHANGES.md for that plugin.

If your change affects lib in an end-user-visible way (fixing a bug, updating a version) then you need to update CHANGES.md for both the lib and the build plugins. Users of a build plugin shouldn't have to refer to lib to see changes that affect them.

This makes it easier for the maintainers to quickly release your changes :)

@nedtwigg nedtwigg changed the title Fix warnings around the mdoclet plugin. Improve build (fix warnings and javadoc) Mar 5, 2020
@nedtwigg nedtwigg requested a review from fvgh March 5, 2020 05:46
@fvgh
Copy link
Member

fvgh commented Mar 5, 2020

@nedtwigg Sorry, not time today. Can do the review tomorrow if you like.

@nedtwigg nedtwigg merged commit 2204946 into master Mar 15, 2020
@nedtwigg nedtwigg deleted the feat/mdoclet-warning-fix branch March 15, 2020 20:44
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.

2 participants