mirror
/
rustc-dev-guide
mirror of https://github.com/rust-lang/rustc-dev-guide.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

issues/issue-12345.rs is an anti-pattern (#456)

This commit is contained in:
Mazdak Farrokhzad 2019-10-01 13:39:49 +02:00 committed by Santiago Pastorino
parent 45a3c4f5cc
commit 544d2326bc
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
src/tests/adding.md
View File

@ -49,12 +49,13 @@ considered an ideal setup.
[`src/test/ui`]: https://github.com/rust-lang/rust/tree/master/src/test/ui/ [`src/test/ui`]: https://github.com/rust-lang/rust/tree/master/src/test/ui/
For regression tests – basically, some random snippet of code that For regression tests – basically, some random snippet of code that
came in from the internet – we often just name the test after the came in from the internet – we often name the test after the issue
issue. For example, `src/test/ui/issue-12345.rs`. If possible, plus a short description. Ideally, the test should be added to a
though, it is better if you can put the test into a directory that directory that helps identify what piece of code is being tested here
helps identify what piece of code is being tested here (e.g., (e.g., `src/test/ui/borrowck/issue-54597-reject-move-out-of-borrow-via-pat.rs`)
`borrowck/issue-12345.rs` is much better), or perhaps give it a more If you've tried and cannot find a more relevant place,
meaningful name. Still, **do include the issue number somewhere**. the test may be added to `src/test/ui/issues/`.
Still, **do include the issue number somewhere**.
When writing a new feature, **create a subdirectory to store your When writing a new feature, **create a subdirectory to store your
tests**. For example, if you are implementing RFC 1234 ("Widgets"), tests**. For example, if you are implementing RFC 1234 ("Widgets"),