Polish README #24981
Polish README #24981
Conversation
vladdoster
commented
Jan 23, 2021
vladdoster
commented
- correct punctuation
- improve readability
- reduce verbiage
- correct grammar
- improve readability and intent for a non-native English speaker (me)
|
@vladdoster Please sign the Contributor License Agreement! Click here to manually synchronize the status of this Pull Request. See the FAQ for frequently asked questions. |
|
@vladdoster Thank you for signing the Contributor License Agreement! |
spring-projects-issues
added
the
status: waiting-for-triage
|
Thanks for the PR, @vladdoster. A number of these are a question of style. @Buzzardo, could you please review this one? |
README.adoc
Outdated
| @@ -12,7 +12,7 @@ Our primary goals are: | |||
|
|
|||
| * Provide a radically faster and widely accessible getting started experience for all Spring development. | |||
| * Be opinionated out of the box, but get out of the way quickly as requirements start to diverge from the defaults. | |||
| * Provide a range of non-functional features that are common to large classes of projects (e.g. embedded servers, security, metrics, health checks, externalized configuration). | |||
| * Provide a range of non-functional features common to large classes of projects (e.g., embedded servers, security, metrics, health checks, externalized configuration). | |||
There was a problem hiding this comment.
"e.g." should be "for example." (We avoid Latin, especially the abbreviations. Not your fault, I know. If you don't fix it, I will.)
| Like other Spring Boot auto-configuration modules, spring-boot-test-autoconfigure, provides auto-configuration for tests based on the classpath. | ||
| It includes a number of annotations that can be used to automatically configure a slice of your application that needs to be tested. | ||
| Like other Spring Boot auto-configuration modules, spring-boot-test-autoconfigure provides auto-configuration for tests based on the classpath. | ||
| It includes many annotations that can automatically configure a slice of your application that needs to be tested. |
There was a problem hiding this comment.
You've done good work in this PR. This bit is especially well done.
|
I know I made a lot of comments. (I'm very particular, both by nature and because it's my job.) However, this work is well done and much appreciated. I also now realize that I have not gone through the README files for our various projects. I will do so. Thanks for that prompt and for the PR. |
philwebb
added
for: merge-with-amendments
|
@vladdoster do you have the time to act on the review and update your contribution? |
snicoll
added
the
status: waiting-for-feedback
This slipped through the cracks. It will be done today. |
spring-projects-issues
added
status: feedback-provided
|
@vladdoster how is it going? Let me know if you want me to take over. |
- correct punctuation - improve readability - reduce verbiage - correct grammar
snicoll
removed
for: merge-with-amendments
|
@vladdoster thank you for the follow-up and for making your first contribution to Spring Boot. |
