Skip to content

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

Closed
wants to merge 2 commits into from
Closed

Polish README #26320

wants to merge 2 commits into from

Conversation

agg505
Copy link
Contributor

@agg505 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 '-'
@pivotal-issuemaster
Copy link

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

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Apr 30, 2021
@pivotal-issuemaster
Copy link

@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.
Copy link
Member

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.

Copy link
Contributor Author

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?

Copy link
Member

Choose a reason for hiding this comment

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

Yes please.

Copy link
Member

@wilkinsona wilkinsona left a 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);
}

Copy link
Member

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok, I see.

@agg505
Copy link
Contributor Author

agg505 commented May 1, 2021

Done. Have a check.

@snicoll snicoll added type: documentation A documentation update and removed status: waiting-for-triage An issue we've not yet triaged labels May 1, 2021
@snicoll snicoll self-assigned this May 1, 2021
@snicoll snicoll added this to the 2.5.0 milestone May 1, 2021
@snicoll snicoll changed the title Polish README.adoc Polish README May 1, 2021
snicoll pushed a commit that referenced this pull request May 1, 2021
@snicoll snicoll closed this in 199bc2d May 1, 2021
@snicoll
Copy link
Member

snicoll commented May 1, 2021

@agg505 thank you for making your first contribution to Spring Boot.

@agg505
Copy link
Contributor Author

agg505 commented May 2, 2021

Such a great learning experience for my first open source contribution.
Thank you! @snicoll

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation A documentation update
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants