重命名文件

您可以在 GitHub 中直接或使用命令行重命名存储库中的任何文件。

平台导航

本文内容

在 GitHub 上重命名文件

重命名文件还为您提供了将文件移动到新位置的机会

提示:

  • 如果您尝试重命名您无权访问的存储库中的文件，我们将把项目分叉到您的个人帐户，并在您提交更改后帮助您向原始存储库发送请求合并。
  • 通过 Web 界面创建的文件名只能包含字母数字字符和连字符 (-)。要使用其他字符，请在本地创建并提交文件，然后将它们推送到存储库。
  • 某些文件（例如图像）要求您从命令行重命名它们。有关详细信息，请参阅“使用命令行重命名文件”。

  1. 在您的存储库中，浏览到您要重命名的文件。

  2. 在文件视图的右上角，单击 以打开文件编辑器。

    Screenshot of a file. In the header, a button, labeled with a pencil icon, is outlined in dark orange.

  3. 在文件名字段中，将文件名更改为您想要的新的文件名。您还可以同时更新文件的内容。

    Screenshot showing a repository file open for editing in the web browser. The file name field is active and highlighted with a dark orange outline.

  4. 单击提交更改...

  5. 在“提交消息”字段中，键入一个简短而有意义的提交消息，描述您对文件所做的更改。您可以在提交消息中将提交归因于多个作者。有关详细信息，请参阅“使用多个作者创建提交”。

  6. 在提交消息字段下方，决定是将您的提交添加到当前分支还是添加到新分支。如果您的当前分支是默认分支，则您应该选择为您的提交创建一个新分支，然后创建一个请求合并。有关详细信息，请参阅“创建请求合并”。

    Screenshot of a GitHub pull request showing a radio button to commit directly to the main branch or to create a new branch. New branch is selected.

  7. 单击提交更改或建议更改。

使用命令行重命名文件

您可以使用命令行重命名存储库中的任何文件。

许多文件可以直接在 GitHub 上重命名，但某些文件（例如图像）要求您从命令行重命名它们。

此过程假定您已经

  1. 打开 终端终端Git Bash。

  2. 将当前工作目录更改为你的本地代码库。

  3. 重命名文件，指定旧文件名和你想要给该文件的新名称。这会暂存你的更改以提交。

    git mv OLD-FILENAME NEW-FILENAME

  4. 使用 git status 检查旧文件名和新文件名。

    $ git status
> # On branch YOUR-BRANCH
> # Changes to be committed:
> #   (use "git reset HEAD <file>..." to unstage)
> #
> #     renamed: OLD-FILENAME -> NEW-FILENAME
> #

  5. 提交你在本地代码库中暂存的文件。

    $ git commit -m "Rename file"
# Commits the tracked changes and prepares them to be pushed to a remote repository.
# To remove this commit and modify the file, use 'git reset --soft HEAD~1' and commit and add the file again.

  6. 将你的本地代码库中的更改推送到 GitHub.com。

    $ git push origin YOUR_BRANCH
# Pushes the changes in your local repository up to the remote repository you specified as the origin