Skip to content
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

docs: improvement for list format in formal writing #169

Closed
2 tasks done
RitaDee opened this issue Sep 22, 2023 · 1 comment · Fixed by #175
Closed
2 tasks done

docs: improvement for list format in formal writing #169

RitaDee opened this issue Sep 22, 2023 · 1 comment · Fixed by #175

Comments

@RitaDee
Copy link
Contributor

RitaDee commented Sep 22, 2023

Description

In formal writing, it is considered standard practice to format lists with the following conventions:

  • List items should begin with a capital letter.
  • List items should end with a full stop (period) rather than a semicolon.
Screenshot 2023-09-22 at 22 09 48

This adjustment adheres to traditional writing guidelines and enhances readability and consistency in written content.

Proposed Changes:

To maintain a more formal and consistent style in our documentation or written materials, we should ensure that lists follow these conventions. Specifically, we should:

  • Start each list item with a capital letter.
  • End each list item with a full stop (period).

Steps to reproduce

  1. Go to 'https://docs.opensauced.pizza/community/100-days-of-oss/.'
  2. Check the second header 'How to Participate.'

Browsers

Chrome

Additional context (Is this in dev or production?)

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct

Contributing Docs

  • I agree to follow this project's Contribution Docs
@github-actions
Copy link
Contributor

🎉 This issue has been resolved in version 1.45.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant