Skip to content

[fix][ci] Rename .github/README.md to CICD.md to avoid masking repo README#888

Open
chuandew wants to merge 1 commit into
dingodb:mainfrom
chuandew:fix/cicd-readme-rename
Open

[fix][ci] Rename .github/README.md to CICD.md to avoid masking repo README#888
chuandew wants to merge 1 commit into
dingodb:mainfrom
chuandew:fix/cicd-readme-rename

Conversation

@chuandew
Copy link
Copy Markdown
Member

Problem

.github/README.md (added in #885) is overriding the root README.md on the repo home page.

GitHub's README lookup order is:

  1. .github/README.md ← currently displayed (CI/CD doc, 14507 bytes)
  2. README.md ← intended (DingoFS project intro, 4814 bytes)
  3. docs/README.md

So visitors landing on https://github.com/dingodb/dingofs now see the CI maintenance doc instead of the project introduction.

Fix

Rename .github/README.md.github/CICD.md. Pure rename, 100% similarity, no content change.

After merge, the repo home page will revert to displaying the original README.md (DingoFS project intro). The CI doc remains accessible at .github/CICD.md.

Verification

  • git diff --stat HEAD~1 shows only the rename, no content change
  • No other file in the repo references .github/README.md (grepped *.md / *.yml / *.sh), so no link breakage

@jackblack369 jackblack369 enabled auto-merge May 15, 2026 10:56
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