BREAKING CHANGE: project renaming

[maehr]

Pull request

Proposed changes

Fix #3

Types of changes

• [ ] New feature (non-breaking change which adds functionality).
• [ ] Enhancement (non-breaking change which enhances functionality)
• [ ] Bug Fix (non-breaking change which fixes an issue).
• [x] Breaking change (fix or feature that would cause existing functionality to change).

Checklist

• [x] I have read the README document.
• [x] My change requires a change to the documentation.
• [x] I have updated the documentation accordingly.

[maehr]

@koilebeit and @mtwente could you please take a look at the proposed changes? It is not an urgent matter, take your time. Thanks in advance

[maehr]

• [ ] Go to the Repository Settings.

  • Visit the current repository URL: https://github.com/maehr/open-data-template/
  • Make sure you are logged into your GitHub account.

• [ ] Click on "Settings".

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

• [ ] Change the Repository Name.

  • Under the "Repository Name" section, click on the current repository name (open-data-template) to edit it.

• [ ] Enter the New Name.

  • Replace open-data-template with open-research-data-template.

• [ ] Update References.

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

• [ ] Confirm Changes.

  • Click on the "Rename" button to confirm the name change.

• [ ] Update Your Local Git Repository (if applicable).

  • If you have a local clone of the repository, update its remote URL 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.

• [ ] Update Website URL (if using GitHub Pages).

  • If you have a GitHub Pages website associated with the repository, update the URL in your repository settings to match the new name:
    • Go to "Settings" > "Pages."
    • Update the source branch or folder to match the new repository name (e.g., main or /docs).

• [ ] Inform Collaborators and Contributors.

  • Ensure that any collaborators or contributors are informed about the name change to avoid confusion.

• [ ] Update Documentation and References.

  • Update any references to the old name in your documentation, README, or other relevant places to avoid confusion for users and collaborators.

• [ ] Verify External Links.

  • Check for any external links pointing to the old repository name and update them to the new name.

• [ ] Test and Verify.

  • After making the changes, test the repository and GitHub Pages website to ensure everything is functioning correctly.

Using this checklist will help ensure a smooth transition when changing the name of your GitHub repository.