Skip to content

Commit f622379

Browse files
JoshBrudnaknedtwigg
authored andcommitted
Fixed broken links in CONTRIBUTING.md and README.md (#282)
* Fixed broken links in CONTRIBUTING.md and README.md #281 * Fixed the README.md formatting
1 parent f6bca4d commit f622379

File tree

2 files changed

+30
-30
lines changed

2 files changed

+30
-30
lines changed

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ If you get something running, we'd love to host your plugin within this repo as
117117

118118
## License
119119

120-
By contributing your code, you agree to license your contribution under the terms of the APLv2: https://github.com/diffplug/spotless/blob/master/LICENSE
120+
By contributing your code, you agree to license your contribution under the terms of the APLv2: https://github.com/diffplug/spotless/blob/master/LICENSE.txt
121121

122122
All files are released with the Apache 2.0 license as such:
123123

README.md

+29-29
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ Spotless can format <java | kotlin | scala | sql | groovy | markdown | licens
1818
- [Spotless for Maven](plugin-maven)
1919
- [Other build systems](CONTRIBUTING.md#how-to-add-a-new-plugin-for-a-build-system)
2020

21-
Ideally, a code formatter can do more than just find formatting errors - it should fix them as well. Such a formatter is really just a `Function<String, String>`, which returns a formatted version of its potentially unformatted input.
21+
Ideally, a code formatter can do more than just find formatting errors - it should fix them as well. Such a formatter is really just a `Function<String, String>`, which returns a formatted version of its potentially unformatted input.
2222

23-
It's easy to build such a function, but there are some gotchas and lots of integration work (newlines, character encodings, idempotency, and build-system integration). Spotless tackles those for you so you can focus on just a simple `Function<String, String>` which can compose with any of the other formatters and build tools in Spotless' arsenal.
23+
It's easy to build such a function, but there are some gotchas and lots of integration work (newlines, character encodings, idempotency, and build-system integration). Spotless tackles those for you so you can focus on just a simple `Function<String, String>` which can compose with any of the other formatters and build tools in Spotless' arsenal.
2424

2525
## Current feature matrix
2626

@@ -47,7 +47,7 @@ lib('kotlin.KtLintStep') +'{{yes}} | {{yes}}
4747
lib('markdown.FreshMarkStep') +'{{yes}} | {{no}} | {{no}} |',
4848
lib('scala.ScalaFmtStep') +'{{yes}} | {{yes}} | {{no}} |',
4949
lib('sql.DBeaverSQLFormatterStep') +'{{yes}} | {{no}} | {{no}} |',
50-
'| [(Your FormatterStep here)](https://github.com/nedtwigg/spotless/blob/markdown-preview-temp/CONTRIBUTING.md#how-to-add-a-new-formatterstep) | {{no}} | {{no}} | {{no}} |',
50+
'| [(Your FormatterStep here)](CONTRIBUTING.md#how-to-add-a-new-formatterstep) | {{no}} | {{no}} | {{no}} |',
5151
'| Fast up-to-date checking | {{yes}} | {{no}} | {{no}} |',
5252
'| Automatic idempotency safeguard | {{yes}} | {{no}} | {{no}} |',
5353
''
@@ -70,35 +70,35 @@ lib('sql.DBeaverSQLFormatterStep') +'{{yes}} | {{no}}
7070
| [`markdown.FreshMarkStep`](lib/src/main/java/com/diffplug/spotless/markdown/FreshMarkStep.java) | :+1: | :white_large_square: | :white_large_square: |
7171
| [`scala.ScalaFmtStep`](lib/src/main/java/com/diffplug/spotless/scala/ScalaFmtStep.java) | :+1: | :+1: | :white_large_square: |
7272
| [`sql.DBeaverSQLFormatterStep`](lib/src/main/java/com/diffplug/spotless/sql/DBeaverSQLFormatterStep.java) | :+1: | :white_large_square: | :white_large_square: |
73-
| [(Your FormatterStep here)](https://github.com/nedtwigg/spotless/blob/markdown-preview-temp/CONTRIBUTING.md#how-to-add-a-new-formatterstep) | :white_large_square: | :white_large_square: | :white_large_square: |
73+
| [(Your FormatterStep here)](CONTRIBUTING.md#how-to-add-a-new-formatterstep) | :white_large_square: | :white_large_square: | :white_large_square: |
7474
| Fast up-to-date checking | :+1: | :white_large_square: | :white_large_square: |
7575
| Automatic idempotency safeguard | :+1: | :white_large_square: | :white_large_square: |
7676
<!---freshmark /matrix -->
7777

7878
## Acknowledgements
7979

80-
* Thanks to [Frank Vennemeyer](https://github.com/fvgh) for [Groovy support via greclipse](https://github.com/diffplug/spotless/issues/13), and a huge body of work with other eclipse-based formatters.
81-
* Thanks to [Konstantin Lutovich](https://github.com/lutovich) for [implementing the maven plugin](https://github.com/diffplug/spotless/pull/188).
82-
* Thanks to [Joan Goyeau](https://github.com/joan38) for [fixing scalafmt integration](https://github.com/diffplug/spotless/pull/260).
83-
* Thanks to [Baptiste Mesta](https://github.com/baptistemesta) for
84-
+ porting the DBeaver formatter to Spotless, and thanks to [DBeaver](https://dbeaver.jkiss.org/) and [its authors](https://github.com/serge-rider/dbeaver/graphs/contributors) for their excellent SQL formatter.
85-
+ making license headers date-aware [#179](https://github.com/diffplug/spotless/pull/179)
86-
* Thanks to [Jonathan Bluett-Duncan](https://github.com/jbduncan) for
87-
+ implementing up-to-date checking [#31](https://github.com/diffplug/spotless/issues/31)
88-
+ breaking spotless into libraries [#56](https://github.com/diffplug/spotless/issues/56)
89-
+ lots of other things, but especially the diff support in `spotlessCheck`
90-
* Thanks to [Stefan Oehme](https://github.com/oehme) for tons of help on the internal mechanics of Gradle.
91-
* Thanks to [eyalkaspi](https://github.com/eyalkaspi) for adding configurable date ranges to the date-aware license headers.
92-
* Thanks to [Oliver Horn](https://github.com/ohorn) for adding AOSP support for Spotless' google-java-format integration.
93-
* Formatting by Eclipse
94-
+ Special thanks to [Mateusz Matela](https://waynebeaton.wordpress.com/2015/03/15/great-fixes-for-mars-winners-part-i/) for huge improvements to the eclipse code formatter!
95-
* Thanks to [Nelson Osacky](https://github.com/runningcode) for android doc improvements, versions bump, and a build improvement.
96-
* Thanks to [Stanley Shyiko](https://github.com/shyiko) for his help integrating [ktlint](https://github.com/shyiko/ktlint).
97-
* Thanks to [Jonathan Leitschuh](https://github.com/JLLeitschuh) for adding [ktlint](https://github.com/shyiko/ktlint) support for [Gradle Kotlin DSL](https://github.com/gradle/kotlin-dsl) files.
98-
* Originally forked from [gradle-format-plugin](https://github.com/youribonnaffe/gradle-format-plugin) by Youri Bonnaffé.
99-
* Thanks to Gábor Bernát for improvements to logging and multi-project support.
100-
* Thanks to Andrew Oberstar for improvements to formatting java source in non-java source sets. [PR #60](https://github.com/diffplug/spotless/pull/60).
101-
* Import ordering from [EclipseCodeFormatter](https://github.com/krasa/EclipseCodeFormatter).
102-
* Built by [gradle](http://gradle.org/).
103-
* Tested by [junit](http://junit.org/).
104-
* Maintained by [DiffPlug](http://www.diffplug.com/).
80+
- Thanks to [Frank Vennemeyer](https://github.com/fvgh) for [Groovy support via greclipse](https://github.com/diffplug/spotless/issues/13), and a huge body of work with other eclipse-based formatters.
81+
- Thanks to [Konstantin Lutovich](https://github.com/lutovich) for [implementing the maven plugin](https://github.com/diffplug/spotless/pull/188).
82+
- Thanks to [Joan Goyeau](https://github.com/joan38) for [fixing scalafmt integration](https://github.com/diffplug/spotless/pull/260).
83+
- Thanks to [Baptiste Mesta](https://github.com/baptistemesta) for
84+
- porting the DBeaver formatter to Spotless, and thanks to [DBeaver](https://dbeaver.jkiss.org/) and [its authors](https://github.com/serge-rider/dbeaver/graphs/contributors) for their excellent SQL formatter.
85+
- making license headers date-aware [#179](https://github.com/diffplug/spotless/pull/179)
86+
- Thanks to [Jonathan Bluett-Duncan](https://github.com/jbduncan) for
87+
- implementing up-to-date checking [#31](https://github.com/diffplug/spotless/issues/31)
88+
- breaking spotless into libraries [#56](https://github.com/diffplug/spotless/issues/56)
89+
- lots of other things, but especially the diff support in `spotlessCheck`
90+
- Thanks to [Stefan Oehme](https://github.com/oehme) for tons of help on the internal mechanics of Gradle.
91+
- Thanks to [eyalkaspi](https://github.com/eyalkaspi) for adding configurable date ranges to the date-aware license headers.
92+
- Thanks to [Oliver Horn](https://github.com/ohorn) for adding AOSP support for Spotless' google-java-format integration.
93+
- Formatting by Eclipse
94+
- Special thanks to [Mateusz Matela](https://waynebeaton.wordpress.com/2015/03/15/great-fixes-for-mars-winners-part-i/) for huge improvements to the eclipse code formatter!
95+
- Thanks to [Nelson Osacky](https://github.com/runningcode) for android doc improvements, versions bump, and a build improvement.
96+
- Thanks to [Stanley Shyiko](https://github.com/shyiko) for his help integrating [ktlint](https://github.com/shyiko/ktlint).
97+
- Thanks to [Jonathan Leitschuh](https://github.com/JLLeitschuh) for adding [ktlint](https://github.com/shyiko/ktlint) support for [Gradle Kotlin DSL](https://github.com/gradle/kotlin-dsl) files.
98+
- Originally forked from [gradle-format-plugin](https://github.com/youribonnaffe/gradle-format-plugin) by Youri Bonnaffé.
99+
- Thanks to Gábor Bernát for improvements to logging and multi-project support.
100+
- Thanks to Andrew Oberstar for improvements to formatting java source in non-java source sets. [PR #60](https://github.com/diffplug/spotless/pull/60).
101+
- Import ordering from [EclipseCodeFormatter](https://github.com/krasa/EclipseCodeFormatter).
102+
- Built by [gradle](http://gradle.org/).
103+
- Tested by [junit](http://junit.org/).
104+
- Maintained by [DiffPlug](http://www.diffplug.com/).

0 commit comments

Comments
 (0)