Skip to content

docs: add repository relocation banner to README#400

Merged
zkoppert merged 3 commits intomainfrom
jm_readme_announcment
Feb 24, 2026
Merged

docs: add repository relocation banner to README#400
zkoppert merged 3 commits intomainfrom
jm_readme_announcment

Conversation

@jmeridth
Copy link
Collaborator

@jmeridth jmeridth commented Feb 24, 2026

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

Pull Request

Proposed Changes

Readiness Checklist

Author/Contributor

  • If documentation is needed for this change, has that been included in this pull request
  • run make lint and fix any issues that you have introduced
  • run make test and ensure you have test coverage for the lines you are introducing
  • If publishing new data to the public (scorecards, security scan results, code quality results, live dashboards, etc.), please request review from @jeffrey-luszcz

Reviewer

  • Label as either bug, documentation, enhancement, infrastructure, maintenance or breaking

## 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>
@jmeridth jmeridth self-assigned this Feb 24, 2026
Copilot AI review requested due to automatic review settings February 24, 2026 01:59
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Feb 24, 2026
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds a prominent notice at the top of the README to inform users that the repository relocated from github/contributors to github-community-projects/contributors, including a copy/paste command to update their git remote.

Changes:

  • Added a GitHub-rendered [!IMPORTANT] banner about the repository move.
  • Included git remote set-url instructions and a brief note about remote naming.

Signed-off-by: jmeridth <jmeridth@gmail.com>
@jmeridth jmeridth requested a review from zkoppert February 24, 2026 02:03
@jmeridth
Copy link
Collaborator Author

@zkoppert this was an idea. All good if we prefer not to use it.

Signed-off-by: jmeridth <jmeridth@gmail.com>
Copy link
Collaborator

@zkoppert zkoppert left a comment

Choose a reason for hiding this comment

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

Thank you! Great idea! 🚀

@zkoppert zkoppert merged commit c5936c5 into main Feb 24, 2026
39 checks passed
@zkoppert zkoppert deleted the jm_readme_announcment branch February 24, 2026 03:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants