openrewrite / rewrite-docs

Stores the markdown documents used to generate docs.openrewrite.org
https://docs.openrewrite.org
Apache License 2.0
41 stars 52 forks source link

Refaster credit #313

Closed lowasser closed 1 month ago

lowasser commented 1 month ago

Is there any chance that https://docs.openrewrite.org/authoring-recipes/refaster-recipes can at least briefly credit and link to my 2013 paper outlining the concept or the original open-source Refaster whose annotations you use?

I would've just sent a pull request, but I was struggling to wordsmith it a bit.

It looks like you have your own implementation which is pretty cool!

sambsnyd commented 1 month ago

Yes I agree that would be fair. I've pushed this commit, adding the following text to the top of the article:

Refaster is an open source refactoring technology unaffiliated with OpenRewrite, originally presented to the world by Louis Wasserman in his 2013 paper. Refaster is easy to use and understand even for developers with no prior experience with parsers, compilers, or other refactoring tools. OpenRewrite has independently implemented support for Refaster-style templates so that recipe authors can benefit from Refaster's accessibility and existing catalogue of useful refactoring operations.

Hopefully that wordsmithing smiths right for you. If not happy to make adjustments. Cheers!

sambsnyd commented 1 month ago

Feel free to open a PR if you'd like to adjust the wording I've added. Also feel free to send me a message on our community slack, I would be happy to chat with you.

lowasser commented 1 month ago

Thanks, that sounds great! I appreciate it.