Skip to content

Commit 8656774

Browse files
committed
docs: add repository relocation banner to README
## What Added an important notice banner at the top of the README informing users that the repository has moved from `github/contributors` to `github-community-projects/contributors`, with instructions to update their git remote. ## Why Users with existing clones still pointing at the old github/contributors remote need a clear, visible notification about the move and a copy-paste command to update their remote URL. ## Notes - Uses GitHub's `[!IMPORTANT]` alert syntax which only renders on GitHub — won't display as a callout in other markdown renderers Signed-off-by: jmeridth <jmeridth@gmail.com>
1 parent 373891b commit 8656774

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
> [!IMPORTANT]
2+
> This repository has moved from `github/contributors` to `github-community-projects/contributors`.
3+
> Please update your git remote:
4+
>
5+
> ```shell
6+
> git remote set-url origin https://github.com/github-community-projects/contributors.git
7+
> ```
8+
>
9+
> Note: replace `origin` with the name of your remote if it's different.
10+
111
# Contributors action
212
313
[![Python package](https://github.com/github-community-projects/contributors/actions/workflows/python-ci.yml/badge.svg)](https://github.com/github-community-projects/contributors/actions/workflows/python-ci.yml)

0 commit comments

Comments
 (0)