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: rename readme file to uppercase #2956

Merged
merged 3 commits into from
Jan 15, 2025

Conversation

sukvvon
Copy link
Contributor

@sukvvon sukvvon commented Jan 15, 2025

Summary

  • Like CONTRIBUTING.md DISCUSSION_TEMPLATE, ISSUE_TEMPLATE, LICENSE, renamed doc files to uppercase for consistency
  • A README.md written in uppercase is traditionally widely used, and following this convention aligns with common practices.
    • Writing README.md in uppercase has been a long-standing convention in the open-source and GitHub communities.
    • This practice makes the filename more noticeable and intuitively conveys its importance as a core file of the project.

Check List

  • pnpm run fix:format for formatting code and docs

Copy link

vercel bot commented Jan 15, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
zustand-demo ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 15, 2025 2:55am

@sukvvon sukvvon changed the title docs(*): rename file to upppercase docs(*): rename files to upppercase Jan 15, 2025
Copy link

codesandbox-ci bot commented Jan 15, 2025

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Copy link

pkg-pr-new bot commented Jan 15, 2025

Open in Stackblitzdemostarter

npm i https://pkg.pr.new/zustand@2956

commit: c8bd7ec

@sukvvon sukvvon changed the title docs(*): rename files to upppercase docs(*): rename files to uppercase Jan 15, 2025
@sukvvon
Copy link
Contributor Author

sukvvon commented Jan 15, 2025

@dai-shi
Copy link
Member

dai-shi commented Jan 15, 2025

If both are officially supported, let's keep it lowercase.

@sukvvon sukvvon changed the title docs(*): rename files to uppercase docs(*): rename readme file to uppercase Jan 15, 2025
Copy link
Member

@dai-shi dai-shi left a comment

Choose a reason for hiding this comment

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

We don't need (*) in the PR title, do we?

@sukvvon sukvvon changed the title docs(*): rename readme file to uppercase docs: rename readme file to uppercase Jan 15, 2025
@dai-shi dai-shi merged commit f42e670 into pmndrs:main Jan 15, 2025
28 checks passed
@sukvvon sukvvon deleted the docs/change-md-uppercase branch January 15, 2025 05:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants