我应该将哪些文件放入我的 GitHub 存储库中

问题描述 投票:0回答:1

我正在为我的 Rust 项目创建一个 GitHub 存储库,但是文件很多,所以我只是想知道:

我应该将哪些文件放入存储库中,以及我应该绝对确保哪些文件不在存储库中?

我尝试过搜索,但什么也没找到。

rust version-control
1个回答
4
投票

绝对需要包含的文件:

  • 货物.toml
  • 来源/

需要包含的文件(如果有):

  • 构建.rs

大多数情况下应包含的文件:

  • 货物锁
  • .gitignore

应包含的文件(如果有):

  • README.md、LICENSE.md 等
  • rustfmt.toml
  • .货物/
  • rust-toolchain.toml
  • 示例/
  • 测试/
  • 长凳/

不应包含的文件:

  • 目标/

默认情况下,如果您使用

cargo new
cargo init
创建项目,Cargo 将生成一个 .gitignore 文件,因此您无需执行任何特殊操作。

# .gitignore
/target

一般来说,Rust 会将任何需要忽略的文件放在 target/ 中,但是当然,如果你有需要忽略的非 Rust 文件,你可以将它们添加到 .gitignore

© www.soinside.com 2019 - 2024. All rights reserved.