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

Refactor all READMEs #633

Merged
merged 16 commits into from
Jul 2, 2020
Merged

Refactor all READMEs #633

merged 16 commits into from
Jul 2, 2020

Conversation

nedtwigg
Copy link
Member

@nedtwigg nedtwigg commented Jul 1, 2020

No description provided.

@nedtwigg
Copy link
Member Author

nedtwigg commented Jul 1, 2020

Originally we just had java (eclipse and google-java-format) and generic, with undirected organic growth from that to a dozen different languages. So there was a ton of important information, but it was not organized. I reorganized it according to this principle:

  • Languages
    • Java
      • (example showing default target and license, and the shortest-possible example of each step)
      • java-specific formatterstep 1
        • link to the formatter homepage, link to the formatter changelog
        • details of spotless DSL for that step
      • java-specific formatterstep 2
        • link to the formatter homepage, link to the formatter changelog
        • details of spotless DSL for that step
    • Groovy
      ....
  • Language independent
    • Generic steps
    • License header
    • Line endings
    • Ratchet from, etc.

I apologize if I lost anything important, please feel free to put anything back in that I took out. I tried to be careful, but I'm sure some of the links and examples are broken.

@nedtwigg nedtwigg changed the title Refactor the root and gradle readmes Refactor all READMEs Jul 2, 2020
@nedtwigg nedtwigg merged commit 15a8da7 into main Jul 2, 2020
@nedtwigg nedtwigg deleted the feat/readme-refactor branch July 2, 2020 00:33
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.

1 participant