maehr / open-research-data-template

GitHub template for FAIR and open research data
https://maehr.github.io/open-research-data-template/
GNU Affero General Public License v3.0
18 stars 1 forks source link

Renaming to open-research-data-template #3

Closed maehr closed 10 months ago

maehr commented 10 months ago

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 to open-research-data-template, you can follow these steps:

  1. Go to the Repository Settings:

  2. Click on "Settings":

    • On the right-hand side, you'll see a menu. Click on "Settings" near the bottom.
  3. Change the Repository Name:

    • Under the "Repository Name" section, you'll see your current repository name (open-data-template).
    • Click on the current repository name to edit it.
  4. Enter the New Name:

    • Replace open-data-template with open-research-data-template.
  5. Update References:

    • GitHub will check if the new name is available. If it is, you will see a green checkmark.
    • Scroll down and make sure to check the box that says "I understand, update the references."
  6. Confirm Changes:

    • Click on the "Rename" button to confirm the name change.
  7. Update Your Local Git Repository (if applicable):

    • If you have a local clone of the repository, you'll need to update its remote URL. You can do this using the following command:
      git remote set-url origin https://github.com/maehr/open-research-data-template.git
    • Replace the URL with the new repository URL.
  8. Update Website URL:

    • 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:

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