docs: improve README with typo fixes and clearer setup instructions #183
Conversation
seshathri044
commented
Sep 4, 2025
seshathri044
commented
- Fixed typo: "bellow" → "below"
- Improved SDK description for clarity
- Updated "Get in touch" section to use Markdown email link
- Reworded IntelliJ instructions for better readability
- Converted VS Code instructions into step-by-step bullet points
There was a problem hiding this comment.
@seshathri044 Thanks for the contribution, it looks great! I'm adding a few small optional suggestions if you don't mind.
| To add GoogleStyle formatting in IntelliJ go to `Preferences -> Editor - Code Style -> Java`. From Schema `Import Schema` and select file `docs/java-google-style.xml` | ||
| Once added, you now be able to Reformat Code using GoogleStyle, which can be triggered from the Code menu or with the Ctrl-Alt-L (by default) keyboard shortcut. | ||
|
|
||
| Once added, you will be able to reformat code using GoogleStyle. This can be triggered from the Code menu or with the `Ctrl + Alt + L` shortcut (default). |
There was a problem hiding this comment.
Missing blank line before title.
| Once added, you will be able to reformat code using GoogleStyle. This can be triggered from the Code menu or with the `Ctrl + Alt + L` shortcut (default). | |
| Once added, you will be able to reformat code using GoogleStyle. This can be triggered from the Code menu or with the `Ctrl + Alt + L` shortcut (default). | |
There was a problem hiding this comment.
Also, for consistency, can we also enumerate items here as we did with VS Code instructions above?
There was a problem hiding this comment.
Sorry I see you've resolved this thread, but I don't see the changes requested in it. Please let me know if you need help and we can also push a commit or two. 😉
There was a problem hiding this comment.
Thanks for catching that, @emyller! My mistake — I thought I had pushed the changes. I’ll update the README with the blank line and enumerated items shortly.
There was a problem hiding this comment.
Thanks again for the feedback, @emyller . I’ve updated the README with the blank line before the IntelliJ section and enumerated the steps for consistency with VS Code. Please let me know if any further tweaks are needed.
Also, if you don’t mind me asking, I’m trying to improve as an open source contributor — do you have any tips on how to get better or become a regular contributor? Any guidance would be really appreciated!
There was a problem hiding this comment.
Thanks again for the feedback, @emyller . I’ve updated the README with the blank line before the IntelliJ section and enumerated the steps for consistency with VS Code. Please let me know if any further tweaks are needed.
Did you git push changes? 👀
Also, if you don’t mind me asking, I’m trying to improve as an open source contributor — do you have any tips on how to get better or become a regular contributor? Any guidance would be really appreciated!
Thanks for your interest in contributing to OSS! Ultimately, really any contribution is welcome. The technical bits (e.g. code) are usually only a means to an end, but they involve a lot of communication and learning so paying attention to detail and being thorough is important in every pull request, and in every conversation, as it makes collaborative effort a lot easier and enriching for everyone. There's one phrase (from Doctor Who) I enjoy at work and life: always try to be nice, never fail to be kind.
You're doing great. Keep it up!
Co-authored-by: Evandro Myller <22429+emyller@users.noreply.github.com>
