Skip to content

docs: improve README with typo fixes and clearer setup instructions #183

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: improve README with typo fixes and clearer setup instructions #183

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6eeb6ae
docs(README): fix typos, improve formatting and clarity
seshathri044 Sep 4, 2025
6f59f48
Update README.md
seshathri044 Sep 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

> Flagsmith allows you to manage feature flags and remote config across multiple projects, environments and organisations.

The SDK for Android and Java applications for [https://www.flagsmith.com/](https://www.flagsmith.com/).
This SDK enables Android and Java applications to integrate with [Flagsmith](https://www.flagsmith.com/).

## Adding to your project

Expand All @@ -20,21 +20,21 @@ If you encounter a bug or feature request we would like to hear about it. Before

## Get in touch

If you have any questions about our projects you can email <a href="mailto:[email protected]">[email protected]</a>.
If you have any questions about our projects, email us at [[email protected]](mailto:[email protected]).

## Code Style formatting
We are using Google Java Style for code formatting. To install one see instructions bellow

We use Google Java Style for code formatting. To install it, see the instructions below.

### VS Code

Install extension [Checkstyle for Java](https://marketplace.visualstudio.com/items?itemName=shengchen.vscode-checkstyle)
Use `java-google-style.xml` file in docs folder to set as Checkstyle configuration file.
1. Install the [Checkstyle for Java](https://marketplace.visualstudio.com/items?itemName=shengchen.vscode-checkstyle) extension.
2. Use the `java-google-style.xml` file in the `docs` folder as the Checkstyle configuration file.

### IntelliJ

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).
Copy link

@emyller emyller Sep 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing blank line before title.

Suggested change
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).

Copy link

@emyller emyller Sep 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, for consistency, can we also enumerate items here as we did with VS Code instructions above?

Copy link

@emyller emyller Sep 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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. 😉

Copy link
Author

@seshathri044 seshathri044 Sep 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Author

@seshathri044 seshathri044 Sep 14, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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!

Copy link

@emyller emyller Sep 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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!

## Useful links

[Website](https://www.flagsmith.com/)
Expand Down