From: Shivani Bhardwaj <shivanib134@gmail.com>
Date: Mon, 20 Feb 2023 05:26:03 +0000 (+0530)
Subject: createst: update the default README
X-Git-Tag: suricata-6.0.12~27
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d5acbcd7bb623cf42d43e2d07eec043e0caf3f84;p=thirdparty%2Fsuricata-verify.git

createst: update the default README
---

diff --git a/createst.py b/createst.py
index 2c500a185..b34c6da8e 100755
--- a/createst.py
+++ b/createst.py
@@ -132,15 +132,12 @@ def create_readme():
     """
     readme_path = os.path.join(test_dir, "README.md")
     with open(readme_path, "w+") as fp:
-        fp.write("Description\n")
-        fp.write("===========\n")
-        fp.write("<TODO>\n\n")
-        fp.write("PCAP\n")
-        fp.write("====\n")
-        fp.write("<TODO>\n\n")
-        fp.write("Reported by\n")
-        fp.write("===========\n")
-        fp.write("Your Name <yourmail@example.com>\n")
+        fp.write("# Test Description\n\n")
+        fp.write("TODO: Simple description of what this test is for.\n\n")
+        fp.write("## PCAP\n\n")
+        fp.write("TODO: What is the source of this PCAP.\n\n")
+        fp.write("## Related issues\n\n")
+        fp.write("TODO: Issue numbers or links to related issues.\n")
 
 
 def write_to_file(data):