Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Renaming to open-research-data-template #3

Closed
maehr opened this issue Oct 14, 2023 · 0 comments · Fixed by #4
Closed

Renaming to open-research-data-template #3

maehr opened this issue Oct 14, 2023 · 0 comments · Fixed by #4
Assignees
Labels
enhancement New feature or request

Comments

@maehr
Copy link
Owner

maehr commented Oct 14, 2023

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:

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

No response

@maehr maehr self-assigned this Oct 14, 2023
@maehr maehr added the enhancement New feature or request label Oct 14, 2023
@maehr maehr closed this as completed in #4 Oct 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant