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: content/code-security/tutorials/manage-security-alerts/best-practices-for-participating-in-a-security-campaign.md
+34-30Lines changed: 34 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
-
title: Best practices for participating in a code security campaign
3
-
shortTitle: Best practices for campaigns
4
-
intro: Learn how you can successfully take part in a security campaign for {% data variables.product.prodname_code_scanning %} alerts and how it can benefit your career as well as your code.
2
+
title: Participating in a code security campaign
3
+
shortTitle: Participate in campaigns
4
+
intro: If you’ve been assigned alerts as part of a security campaign, this guide explains what campaigns are, what to expect, and how to resolve alerts effectively.
5
5
allowTitleToDifferFromFilename: true
6
6
permissions: '{% data reusables.permissions.code-scanning-all-alerts %}'
7
7
product: '{% data reusables.gated-features.security-campaigns %}'
A security campaign is a group of {% data variables.product.prodname_code_scanning %} alerts, detected in the default branches of repositories, chosen by an organization owner or security manager for remediation.
22
+
A code security campaign is a focused effort to remediate a defined group of {% data variables.product.prodname_code_scanning %} alerts across one or more repositories.
23
23
24
-
You can take part in a security campaign by fixing one or more of the alerts included in the campaign.
24
+
Campaigns are created by organization owners or security managers and typically target alerts detected in the default branches of repositories. If you’re participating in a campaign, you’ve been asked to help resolve some of these alerts.
25
25
26
-
## What are the benefits of participating in a campaign
26
+
## What are the benefits of participating in a campaign?
27
27
28
-
In addition to the benefit of removing an important security problem from your organization's codebase, alerts in a security campaign have several other benefits compared with fixing another alert in your repository.
28
+
In addition to reducing risk in your organization’s codebase, alerts in a security campaign have several other benefits compared with fixing another alert in your repository.
29
29
30
30
* You have a campaign manager on the security team to collaborate with and a specific contact link for discussing campaign activities.
31
31
* You know that you are fixing a security alert that is important to the company.
@@ -34,9 +34,11 @@ In addition to the benefit of removing an important security problem from your o
34
34
* If you have access to {% data variables.copilot.copilot_chat %}, you can ask questions about the alert and the suggested fix.{% endif %}
35
35
* You are improving and demonstrating your knowledge of secure coding.
36
36
37
-
Adopting a few key best practices can help you participate successfully in a campaign.
37
+
Participating in a campaign helps reduce risk in your organization’s codebase while strengthening your secure coding skills.
38
38
39
-
## Stay informed
39
+
## 1. Learn about campaigns
40
+
41
+
Start by reviewing campaign updates and deadlines so you can plan your work effectively.
40
42
41
43
### Notification settings
42
44
@@ -50,15 +52,15 @@ When you open the **Security** tab for a repository with one or more campaign al
50
52
51
53
### Campaign-generated {% data variables.product.prodname_github_issues %}
52
54
53
-
Some campaigns automatically create {% data variables.product.prodname_github_issues %} for each repository which details the campaign managers, contact URL, and due date.
55
+
Some campaigns automatically create {% data variables.product.prodname_github_issues %} for each repository that detail the campaign managers, contact URL, and due date.
54
56
55
-
You can use this issue to plan and track campaign work as part of your usual workflows, such as:
57
+
Use this issue to coordinate work, track progress, and keep stakeholders aligned. For example, you might use the issue to:
56
58
57
-
*Adding the issue to project boards
58
-
*Adding assignees
59
-
*Creating sub-issues or tasklists
59
+
*Add the issue to project boards
60
+
*Add assignees
61
+
*Create sub-issues or tasklists
60
62
61
-
## Seek context
63
+
## 2. Build context before applying fixes
62
64
63
65
Your security team may provide you with specific training ahead of participating in a campaign, so that you feel equipped to address the alerts included in the campaign.
64
66
@@ -73,13 +75,25 @@ In addition, there are external resources for understanding common security issu
73
75
* The **OWASP Foundation** provides many resources for learning about the most common vulnerabilities, see [About the OWASP Foundation](https://owasp.org/about/).
74
76
* The **MITRE Corporation** maintains a detailed list of common weaknesses, see [About CWE](https://cwe.mitre.org/about/index.html).
75
77
76
-
## Group similar alerts
78
+
## 3. Collaborate early and often
79
+
80
+
A security campaign will generally include a contact URL, which might link you to the campaign manager, an open forum (such as a {% data variables.product.github %} Discussion), or a website of resources. You should use this space to ask questions about the campaign or specific alerts, find useful resources, and share knowledge.
81
+
82
+
To find the contact URL:
83
+
84
+
1. Open the **Security** tab for your repository.
85
+
1. On the left sidebar, click the name of the campaign you are participating in.
86
+
1. On the campaign tracking page, to the right of the campaign manager's name, click **{% octicon "comment" aria-hidden="true" aria-label="comment" %}**.
87
+
88
+
## 4. Group alerts strategically
77
89
78
-
When fixing security alerts as part of a campaign, it may be helpful to group and fix similar alerts together. By doing so, you can develop a deeper understanding of the underlying issue. As you gain confidence and efficiency in resolving a specific type of alert, it makes it easier and faster for you to resolve subsequent alerts.
90
+
Tackle similar alerts together to build momentum, reduce context switching, and develop a deeper understanding of the underlying issue. As you gain confidence and efficiency in resolving a specific type of alert, it makes it easier and faster for you to resolve subsequent alerts.
79
91
80
92
{% ifversion copilot %}
81
93
82
-
## Leverage {% data variables.product.prodname_copilot_short %}
94
+
## 5. Resolve alerts with the help of {% data variables.product.prodname_copilot_short %}
95
+
96
+
You can leverage {% data variables.product.prodname_copilot_short %} to help resolve alerts in a security campaign. Depending on the features enabled in your repository, you may have access to {% data variables.copilot.copilot_autofix_short %} suggestions and {% data variables.copilot.copilot_chat_short %}.
83
97
84
98
{% ifversion code-scanning-autofix %}
85
99
@@ -111,20 +125,10 @@ For example:
111
125
112
126
```
113
127
114
-
If you don't already have access to {% data variables.copilot.copilot_chat_short %} through your organization{% ifversion ghec %} or enterprise{% endif %}, you can sign up to {% data variables.copilot.copilot_free %}. For more information, see[AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-copilot-free/accessing-github-copilot-free).
128
+
If you don't already have access to {% data variables.copilot.copilot_chat_short %} through your organization{% ifversion ghec %} or enterprise{% endif %}, you can sign up to {% data variables.copilot.copilot_free %}. See[AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-copilot-free/accessing-github-copilot-free).
115
129
116
130
{% endif %}
117
131
118
-
## Ask questions
119
-
120
-
A security campaign will generally include a contact URL, which might link you to the campaign manager, an open forum (such as a {% data variables.product.github %} Discussion), or a website of resources. You should use this space to ask questions about the campaign or specific alerts, find useful resources, and share knowledge.
121
-
122
-
To find the contact URL:
123
-
124
-
1. Open the **Security** tab for your repository.
125
-
1. On the left sidebar, click the name of the campaign you are participating in.
126
-
1. On the campaign tracking page, to the right of the campaign manager's name, click **{% octicon "comment" aria-hidden="true" aria-label="comment" %}**.
0 commit comments