If you have a GitHub Pages website associated with the repository, you may need to update the URL in your repository settings to point to the new name:
Go to "Settings" > "Pages."
Update the source branch or folder to match the new repository name (e.g., main or /docs).
Caveats:
Changing the repository name will update all references within GitHub, including issues, pull requests, forks, and links. However, external links to your repository may break, so you should update those as well.
If you have any automated workflows, CI/CD configurations, or scripts that reference the old repository name, you'll need to update them to use the new name.
Ensure that any collaborators or contributors are informed about the name change to avoid confusion.
Once you've completed these steps, your repository should have the new name, and the URL for your GitHub Pages website should also reflect the change.
Remember to update any references to the old name in your documentation, README, or other relevant places to avoid confusion for users and collaborators.
Please note that this process should be handled with caution, especially if your repository is widely used, to minimize disruption to your users and contributors.
What type of pull request would this be?
Other
Any links to similar examples or other references we should review?
Describe what feature you'd like. Pseudo-code, mockups, or screenshots of similar solutions are encouraged!
Renaming this project with a more clear scope would help users to grasp its purpose faster (I hope).
To change the name of your GitHub repository from
open-data-template
toopen-research-data-template
, you can follow these steps:Go to the Repository Settings:
Click on "Settings":
Change the Repository Name:
open-data-template
).Enter the New Name:
open-data-template
withopen-research-data-template
.Update References:
Confirm Changes:
Update Your Local Git Repository (if applicable):
Update Website URL:
main
or/docs
).Caveats:
Once you've completed these steps, your repository should have the new name, and the URL for your GitHub Pages website should also reflect the change.
Remember to update any references to the old name in your documentation, README, or other relevant places to avoid confusion for users and collaborators.
Please note that this process should be handled with caution, especially if your repository is widely used, to minimize disruption to your users and contributors.
What type of pull request would this be?
Other
Any links to similar examples or other references we should review?
No response