Skip to content

Commit e749a38

Browse files
committedJan 20, 2025·
docs: update contributing docs for submodule/subtree changes
1 parent b5741a3 commit e749a38

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed
 

‎CONTRIBUTING.md

+9
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,15 @@ Documentation for contributing to the compiler or tooling is located in the [Gui
1212
Development][rustc-dev-guide], commonly known as the [rustc-dev-guide]. Documentation for the
1313
standard library in the [Standard library developers Guide][std-dev-guide], commonly known as the [std-dev-guide].
1414

15+
## Making changes to subtrees and submodules
16+
17+
For submodules, changes need to be made against the repository corresponding the
18+
submodule, and not the main `rust-lang/rust` repository.
19+
20+
For subtrees, prefer sending a PR against the subtree's repository if it does
21+
not need to be made against the main `rust-lang/rust` repostory (e.g. a
22+
rustc-dev-guide change that does not accompany a compiler change).
23+
1524
## About the [rustc-dev-guide]
1625

1726
The [rustc-dev-guide] is meant to help document how rustc –the Rust compiler– works,

0 commit comments

Comments
 (0)
Please sign in to comment.