-
Notifications
You must be signed in to change notification settings - Fork 41.2k
Polish README #26320
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
Polish README #26320
Conversation
agg505
commented
Apr 30, 2021
- Change tabs to spaces for better source code rendering
- Capitalize words for headings
- Unify usage for '-'
- Change tabs to spaces for better source code rendering - Capitalize words for headings - Unify usage for '-'
@agg505 Please sign the Contributor License Agreement! Click here to manually synchronize the status of this Pull Request. See the FAQ for frequently asked questions. |
@agg505 Thank you for signing the Contributor License Agreement! |
Are you having trouble with Spring Boot? We want to help! | ||
|
||
* Check the {docs}/html/[reference documentation], especially the {docs}/html/howto.html#howto[How-to's] -- they provide solutions to the most common questions. | ||
* Learn the Spring basics -- Spring Boot builds on many other Spring projects; check the https://spring.io[spring.io] web-site for a wealth of reference documentation. |
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.
I think this should be --
so that they're rendered as an em dash.
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.
So to be consistent, change the single ‘-‘ to double for line 56?
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.
Yes please.
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 very much for the pull request, @agg505. I left a couple of comments. Please let us know what you think.
README.adoc
Outdated
} | ||
public static void main(String[] args) { | ||
SpringApplication.run(Example.class, args); | ||
} | ||
|
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.
We prefer tabs as they're more accessible.
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.
Ok, I see.
Done. Have a check. |
@agg505 thank you for making your first contribution to Spring Boot. |
Such a great learning experience for my first open source contribution. |