Add instruction for how to add a benchmark

README.md

@@ -17,7 +17,35 @@ Tracking AI capabilities in cybersecurity is essential for understanding emergin
 
 ## Submit your benchmark
 
-This leaderboard is a collection of cybersecurity-relevant benchmarks. To submit your benchmark, please use this: https://docs.google.com/forms/d/e/1FAIpQLSd0arYQ0xy9FpGbXwu68rAFpCm0HNb-8ZK8Mma3Ru2oa2Astg/viewform. We will regularly update this leaderboard.
+Please follow the steps below to add your benchmark. 
+
+1. First you need to add your results in results.json. Under the top-level "results" key, you need to insert an entry that looks like this:
+
+```jsonc
+"Your Benchmark Name": {
+  "Metric Name 1": {
+    "Model / Agent Name": [value]
+  },
+  "Metric Name 2": {
+    "Model / Agent Name": [value]
+  }
+}
+```
+
+Here, if you want, you can add multiple metric scores.
+
+2. Then, add descriptive metadata in meta_data.py
+
+```bash
+LEADERBOARD_MD["Your Benchmark Name"] = """
+Brief description of what the benchmark measures.
+
+Paper: <paper URL>  
+Code:  <repository URL>
+"""
+```
+
+3. Lastly, please open a pull request. You need to commit your changes and open a PR against this repository. We will review and merge submissions. If you have any questions, please contact Yujin Potter at [email protected].
 
 ## Paper & Blog
 

about.md

@@ -2,7 +2,35 @@ Tracking AI capabilities in cybersecurity is essential for understanding emergin
 
 ## Submit your benchmark
 
-This leaderboard is a collection of cybersecurity-relevant benchmarks. To submit your benchmark, please use this: https://docs.google.com/forms/d/e/1FAIpQLSd0arYQ0xy9FpGbXwu68rAFpCm0HNb-8ZK8Mma3Ru2oa2Astg/viewform. We will regularly update this leaderboard. 
+Please follow the steps below to add your benchmark. 
+
+1. First you need to add your results in results.json. Under the top-level "results" key, you need to insert an entry that looks like this:
+
+```jsonc
+"Your Benchmark Name": {
+  "Metric Name 1": {
+    "Model / Agent Name": [value]
+  },
+  "Metric Name 2": {
+    "Model / Agent Name": [value]
+  }
+}
+```
+
+Here, if you want, you can add multiple metric scores.
+
+2. Then, add descriptive metadata in meta_data.py
+
+```bash
+LEADERBOARD_MD["Your Benchmark Name"] = """
+Brief description of what the benchmark measures.
+
+Paper: <paper URL>  
+Code:  <repository URL>
+"""
+```
+
+3. Lastly, please open a pull request. You need to commit your changes and open a PR against this repository. We will review and merge submissions. If you have any questions, please contact Yujin Potter at [email protected].
 
 ## Paper & Blog