diff options
| author | 许杰友 Jieyou Xu (Joe) <39484203+jieyouxu@users.noreply.github.com> | 2025-01-20 21:53:59 +0800 |
|---|---|---|
| committer | 许杰友 Jieyou Xu (Joe) <39484203+jieyouxu@users.noreply.github.com> | 2025-01-20 21:53:59 +0800 |
| commit | e749a38886ab868669029cf564c34bf9cad0d1fc (patch) | |
| tree | b376a836ce53f6296ffd8d85ebf2efabac9bc2f1 /CONTRIBUTING.md | |
| parent | b5741a36a897dd93936d31ea0c1688f1399a2e06 (diff) | |
| download | rust-e749a38886ab868669029cf564c34bf9cad0d1fc.tar.gz rust-e749a38886ab868669029cf564c34bf9cad0d1fc.zip | |
docs: update contributing docs for submodule/subtree changes
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index eeff563d8ec..a5ddff595f5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,6 +12,15 @@ Documentation for contributing to the compiler or tooling is located in the [Gui Development][rustc-dev-guide], commonly known as the [rustc-dev-guide]. Documentation for the standard library in the [Standard library developers Guide][std-dev-guide], commonly known as the [std-dev-guide]. +## Making changes to subtrees and submodules + +For submodules, changes need to be made against the repository corresponding the +submodule, and not the main `rust-lang/rust` repository. + +For subtrees, prefer sending a PR against the subtree's repository if it does +not need to be made against the main `rust-lang/rust` repostory (e.g. a +rustc-dev-guide change that does not accompany a compiler change). + ## About the [rustc-dev-guide] The [rustc-dev-guide] is meant to help document how rustc –the Rust compiler– works, |
