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 on Checkstyle Guide #49

Open
chrisgzf opened this issue Mar 4, 2020 · 2 comments
Open

Improve on Checkstyle Guide #49

chrisgzf opened this issue Mar 4, 2020 · 2 comments
Labels
📖 Textbook Contribution A Textbook Contribution

Comments

@chrisgzf
Copy link
Contributor

chrisgzf commented Mar 4, 2020

Hello all,

I've received feedback from people that the guide to setup checkstyle that I wrote in #45 had a few flaws:

  1. Language and phrasing could be improved
  2. Was not portable, only works for Linux/macOS/WSL users
  3. Graphics provided could be confusing because I used a customised shell prompt

There are a few improvements to be made:

  1. Split up the guide into "Windows" and "macOS/Linux/WSL" sections, and write the section for Windows users
  2. For the UNIX-like OS guide, retake the screenshots using vanilla bash
  3. Perhaps split up the UNIX-like OS guide into 2 subsections
    a. "I just want to get checkstyle to work in this folder right now" subsection
    b. "Let's make a nice alias so that we can easily run checkstyle anywhere" subsection (we already have this now)
  4. Improve on the phrasing of instructions

If anyone wants to give these a try, just leave a comment below stating what you want to take up (specific line items or the whole thing are both okay). If you have no idea how to start, no worries, I can guide you.

I intend to eventually work on the improvements over the next few weeks if nobody wants to take them up, but if anyone wants to give it a try, just leave a comment.

@jamesleeht jamesleeht added the 📖 Textbook Contribution A Textbook Contribution label Mar 4, 2020
@purfectliterature
Copy link
Contributor

I can help make the modifications since I use Windows, WSL, and macOS. My Terminal is also not customised. I personally find the current version is great and contextual, though for the average joe, might seem too intimidating with all the teletypes LOL

@chrisgzf
Copy link
Contributor Author

chrisgzf commented Mar 9, 2020

Great! That'd be really helpful, because I don't really have access to Windows or WSL.

Was thinking of sectioning the current guide with panels like this. Though it's up to you how you wanna restructure the guide.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📖 Textbook Contribution A Textbook Contribution
Projects
None yet
Development

No branches or pull requests

3 participants