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

Rename README.md to github-readme.md #5002

Merged
merged 1 commit into from
Oct 12, 2022
Merged

Rename README.md to github-readme.md #5002

merged 1 commit into from
Oct 12, 2022

Conversation

lightmark
Copy link
Contributor

@lightmark lightmark commented Oct 12, 2022

Description

This file as README.md will replace the one at root dir and shown on github.
https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes

Test Plan


This change is Reviewable

This file as README.md will replace the one at root dir and shown on github.
@lightmark lightmark requested a review from a team as a code owner October 12, 2022 18:23
@lightmark lightmark enabled auto-merge (squash) October 12, 2022 18:39
Copy link
Contributor

@clay-aptos clay-aptos left a comment

Choose a reason for hiding this comment

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

I can't tell from the link supplied why we need to conduct this rename. What are the effects? Do you have a link to docs explaining the purpose of having a github-readme.md file? My initial searches are proving fruitless:
https://www.google.com/search?q=%22github-readme.md%22

@perryjrandall perryjrandall merged commit 02b9669 into main Oct 12, 2022
@perryjrandall perryjrandall deleted the lightmark-patch-1 branch October 12, 2022 18:57
perryjrandall pushed a commit that referenced this pull request Oct 12, 2022
This file as README.md will replace the one at root dir and shown on github.
@Markuze Markuze mentioned this pull request Oct 13, 2022
@banool banool mentioned this pull request Oct 24, 2022
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.

4 participants