From 3bf280d493692133945fb8d055f6e6b1dd6e0f98 Mon Sep 17 00:00:00 2001 From: alstr Date: Tue, 24 Sep 2024 14:12:58 +0100 Subject: [PATCH] Update README.md --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 0992b7c..7657be4 100644 --- a/README.md +++ b/README.md @@ -230,6 +230,14 @@ jobs: git push origin main ``` +You will probably also want to use the setting `CLOSE_ISSUES: "true"`, to allow issues to be closed when a TODO is +removed. + +Please note, URL insertion works best with line comments, as it has to insert a line into the file. If using block +comments, you should put the start and end tags on their own lines. This may be improved in the future. + +This feature is not perfect. Please make sure you're comfortable with that before enabling. + ### Projects You can configure the action to add newly created issues to a specified v2 project (i.e., not a classic project).