]> git.ipfire.org Git - thirdparty/suricata-verify.git/commitdiff
createst: update the default README
authorShivani Bhardwaj <shivanib134@gmail.com>
Mon, 20 Feb 2023 05:26:03 +0000 (10:56 +0530)
committerShivani Bhardwaj <shivanib134@gmail.com>
Wed, 22 Mar 2023 06:28:36 +0000 (11:58 +0530)
createst.py

index 2c500a185a81dd7786b4dd5c91ec21a24e1c12d1..b34c6da8e04b8cd9ef4bd81d6bd08f9d768dc542 100755 (executable)
@@ -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):