-
Notifications
You must be signed in to change notification settings - Fork 493
Add documentation showing how to share configuration #2643
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
Conversation
|
@nedtwigg Can this be reviewed please? :-) |
|
This will get merged eventually, but I have enough edits that it's easier to just edit it than request changes. If there is some other task blocked on this let me know, otherwise I will probably not get around to this until enough PRs get merged to warrant a release. |
|
@nedtwigg Thanks for the reply. I have nothing blocked on this ; this was the bit I found was missing from the docs in order not to have store the format styles locally in each repository. I'd be happy to edit if you wish. |
Pankraz76
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nice addition to improve overall experience, Thanks.
plugin-gradle/README.md
Outdated
| - [Dependency resolution modes](#dependency-resolution-modes) | ||
| - [How do I preview what `spotlessApply` will do?](#how-do-i-preview-what-spotlessapply-will-do) | ||
| - [Can I apply Spotless to specific files?](#can-i-apply-spotless-to-specific-files) | ||
| - [Sharing Spotless Configuration](#sharing-configuration) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In the previous point, the verbs appear in their base form — preview, apply, share — rather than in their continuous forms (previewing, applying, sharing).
We could continue using this style for consistency, ensuring a cohesive look and feel.
| - [Sharing Spotless Configuration](#sharing-configuration) | |
| - [Share Spotless Configuration](#sharing-configuration) |
Please DO NOT FORCE PUSH. Don't worry about messy history, it's easier to do code review if we can tell what happened after the review, and force pushing breaks that.
Please make sure that your PR allows edits from maintainers. Sometimes it's faster for us to just fix something than it is to describe how to fix it.
After creating the PR, please add a commit that adds a bullet-point under the
[Unreleased]section of CHANGES.md, plugin-gradle/CHANGES.md, and plugin-maven/CHANGES.md which includes:If your change only affects a build plugin, and not the lib, then you only need to update the
plugin-foo/CHANGES.mdfor 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.mdfor both the lib and all 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 :)
Fixes #2428