From 91a83c4fa7299f0b1ef50cec424d5825c4bea267 Mon Sep 17 00:00:00 2001 From: Martin Vidner Date: Fri, 2 May 2025 11:23:35 +0200 Subject: [PATCH] PR template: More hints which docs to update --- PULL_REQUEST_TEMPLATE.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md index 83eebf4176..b8d1f7d456 100644 --- a/PULL_REQUEST_TEMPLATE.md +++ b/PULL_REQUEST_TEMPLATE.md @@ -30,5 +30,13 @@ *other times they need advertisement and explanation.* *Look for relevant sections and adjust:* -- ([source](https://github.com/agama-project/agama-project.github.io/)) +- The description parts of the [JSON schema][profile.schema.json] +- Is the CLI affected? See [cli.md][] for a complete overview, + change the `///` comments (rust doc) + and update the .md with `cargo xtask markdown` +- ([source][gh.io]) - Run: `git ls-files '*.md'` + +[cli.md]: https://github.com/agama-project/agama-project.github.io/blob/main/docs/user/cli.md +[profile.schema.json]: https://github.com/agama-project/agama/blob/master/rust/agama-lib/share/profile.schema.json +[gh.io]: https://github.com/agama-project/agama-project.github.io/