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

Kaz*_*ala 2 version-control rust

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

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

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

dre*_*ato 5

绝对需要包含的文件:

  • Cargo.toml
  • 源代码/

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

  • 构建.rs

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

  • 货锁
  • .gitignore

如果您有的话,应该包含这些文件:

  • README.md、LICENSE.md 等
  • rustfmt.toml
  • 。货物/
  • Rust 工具链.toml
  • 例子/
  • 测试/
  • 长凳/

不应包含的文件:

  • 目标/

cargo new默认情况下,如果您使用或创建项目cargo init,Cargo 将生成一个.gitignore文件,因此您无需执行任何特殊操作。

# .gitignore
/target
Run Code Online (Sandbox Code Playgroud)

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