You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/instructions/huntingqueries.instructions.md
+18Lines changed: 18 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -75,6 +75,24 @@ Hunting Queries are YAML files that define proactive search queries in Microsoft
75
75
- **Instead do this** (specific and clear):
76
76
- ✅ "Calculate the count of BytesIn per Source-Destination pair over 12/24 hours. Higher values may indicate beaconing. C2 servers reply with the same data, making BytesIn value the same."
- **When to Use**: When the description exceeds 255 characters and additional context is needed
81
+
- **Format**: Extended narrative text (no hard character limit)
82
+
- **Rules**:
83
+
- Only use if `description` field cannot adequately convey the hunting methodology within 255 characters
84
+
- Provides supplementary information about the query purpose, methodology, or hunt rationale
85
+
- Can include more detailed explanation of patterns, thresholds, and threat indicators
86
+
- Can provide context about why certain data sources or time windows were chosen
87
+
- Useful for complex hunts that require deeper explanation
88
+
- **When NOT to Use**:
89
+
- If the 255-character description is sufficient
90
+
- If the additional content is just repetition of the description
91
+
- For implementation details or technical KQL explanations
92
+
- **Example Usage**:
93
+
- **description**: "Identify service accounts with unusually high failed login attempts within a short timeframe, which may indicate credential compromise or brute force attacks."
94
+
- **description-detailed**: "This hunt searches for service accounts that experience more than 10 failed login attempts within a 1-hour window across multiple workstations. Service accounts should typically have successful logins; repeated failures may indicate credential compromise, brute force attempts, or misconfigured applications. Focus on investigating the affected workstations and reviewing access logs for those time periods. Check if any recent password changes or security alerts occurred before the failed attempts."
95
+
78
96
#### **requiredDataConnectors** (Data Sources)
79
97
- **Required**: Yes
80
98
- **Type**: Array of objects with `connectorId` and `dataTypes`
Copy file name to clipboardExpand all lines: .github/instructions/releasenotes.instructions.md
+19Lines changed: 19 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,6 +30,25 @@ Exactly three columns in this order:
30
30
| **No Duplicates** | Each version must appear only once | 3.0.1 appears twice | Each version appears once |
31
31
| **All 3 Columns Present** | Table must have exactly 3 columns, no more, no less | 2 columns or 4 columns | Exactly 3 columns |
32
32
33
+
## When to Update Release Notes
34
+
35
+
Release notes **MUST be updated** for any of the following changes:
36
+
37
+
- **Content changes**: Modifications to Analytical Rules, Hunting Queries, Workbooks, Data Connectors, or any other solution content
38
+
- **Package folder changes**: ANY changes to files in `Solutions/{SolutionName}/Package/` folder (metadata, configurations, solution settings)
39
+
- **Parser/Function updates**: Changes to KQL parsers or custom functions
40
+
- **Documentation updates**: Updates to README or other documentation files
41
+
- **Bug fixes**: Any bug fixes to existing content
42
+
- **Performance improvements**: Optimizations to queries or logic
43
+
- **New content**: Addition of new Analytical Rules, Workbooks, Hunting Queries, etc.
44
+
- **Deprecated content**: Marking components as deprecated or removing content
45
+
46
+
Release notes are **NOT required** for:
47
+
- Changes only to non-solution files (e.g., standalone scripts outside Solutions folder)
48
+
- Documentation-only PRs that don't affect solution content
49
+
50
+
**Important:** If your PR includes changes to `Solutions/{SolutionName}/Package/` folder, updating ReleaseNotes.md is mandatory. Failure to update release notes when package folder changes will result in PR review failure.
51
+
33
52
## Best Practices
34
53
35
54
- **Clear descriptions:** Specify which component changed (e.g., "Updated query in **Analytical Rule**", "Fixed bug in **Data Connector**")
0 commit comments