From 5cad46d15a23a23f3075cdd285f5578b2da57e43 Mon Sep 17 00:00:00 2001 From: Lzu Tao Date: Thu, 8 Aug 2019 21:37:19 +0700 Subject: [PATCH] template: Update how to format source code with ./util/dev --- .github/PULL_REQUEST_TEMPLATE | 6 ++++-- doc/adding_lints.md | 4 +++- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE index 5567b84b3..e4a9381f5 100644 --- a/.github/PULL_REQUEST_TEMPLATE +++ b/.github/PULL_REQUEST_TEMPLATE @@ -16,9 +16,11 @@ checked during review or continuous integration. - [ ] Followed [lint naming conventions][lint_naming] - [ ] Added passing UI tests (including committed `.stderr` file) - [ ] `cargo test` passes locally -- [ ] Executed `util/dev update_lints` +- [ ] Executed `./util/dev update_lints` - [ ] Added lint documentation -- [ ] Run `cargo fmt` +- [ ] Run `./util/dev fmt` + +[lint_naming]: https://rust-lang.github.io/rfcs/0344-conventions-galore.html#lints Note that you can skip the above if you are just opening a WIP PR in order to get feedback. diff --git a/doc/adding_lints.md b/doc/adding_lints.md index 0e73bdba1..ef09c4230 100644 --- a/doc/adding_lints.md +++ b/doc/adding_lints.md @@ -368,10 +368,12 @@ output in the `stdout` part. Before submitting your PR make sure you followed all of the basic requirements: + + - [ ] Followed [lint naming conventions][lint_naming] - [ ] Added passing UI tests (including committed `.stderr` file) - [ ] `cargo test` passes locally -- [ ] Executed `util/dev update_lints` +- [ ] Executed `./util/dev update_lints` - [ ] Added lint documentation - [ ] Run `./util/dev fmt`