-
Notifications
You must be signed in to change notification settings - Fork 21
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.
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
seshathri044
wants to merge
2
commits into
Flagsmith:main
Choose a base branch
from
seshathri044:patch-1
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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 | ||
|
|
||
|
|
@@ -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). | ||
| ## Useful links | ||
|
|
||
| [Website](https://www.flagsmith.com/) | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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. 😉
There was a problem hiding this comment.
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.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
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!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Did you
git pushchanges? 👀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!