Skip to content

Commit 9e75f8c

Browse files
committed
chore: linting
1 parent 6b4e258 commit 9e75f8c

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

_articles/security-best-practices-for-your-project.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ To prevent such scenarios, Software Composition Analysis (SCA) tools such as Dep
5656

5757
Using open source dependencies can speed up development, but each package includes a license that defines how it can be used, modified, or distributed. Some licenses are permissive, while others (like AGPL or SSPL) impose restrictions that may not be compatible with your project's goals or your users' needs.
5858

59-
Imagine this: You add a powerful library to your project, unaware that it uses a restrictive license. Later, a company wants to adopt your project but raises concerns about license compliance. The result? You lose adoption, need to refactor code, and your projects reputation takes a hit.
59+
Imagine this: You add a powerful library to your project, unaware that it uses a restrictive license. Later, a company wants to adopt your project but raises concerns about license compliance. The result? You lose adoption, need to refactor code, and your project's reputation takes a hit.
6060

6161
To avoid these pitfalls, consider including automated license checks as part of your development workflow. These checks can help identify incompatible licenses early in the process, preventing problematic dependencies from being introduced into your project.
6262

@@ -86,13 +86,13 @@ On some platforms, you can streamline and strengthen your vulnerability manageme
8686

8787
### Define your threat model to help users and researchers understand scope
8888

89-
Before security researchers can report issues effectively, they need to understand what risks are in scope. A lightweight threat model can help define your projects boundaries, expected behavior, and assumptions.
89+
Before security researchers can report issues effectively, they need to understand what risks are in scope. A lightweight threat model can help define your project's boundaries, expected behavior, and assumptions.
9090

91-
A threat model doesnt need to be complex. Even a simple document outlining what your project does, what it trusts, and how it could be misused goes a long way. It also helps you, as a maintainer, think through potential pitfalls and inherited risks from upstream dependencies.
91+
A threat model doesn't need to be complex. Even a simple document outlining what your project does, what it trusts, and how it could be misused goes a long way. It also helps you, as a maintainer, think through potential pitfalls and inherited risks from upstream dependencies.
9292

93-
A great example is the [Node.js threat model](https://github.com/nodejs/node/security/policy#the-nodejs-threat-model), which clearly defines what is and isnt considered a vulnerability in the projects context.
93+
A great example is the [Node.js threat model](https://github.com/nodejs/node/security/policy#the-nodejs-threat-model), which clearly defines what is and isn't considered a vulnerability in the project's context.
9494

95-
If youre new to this, the [OWASP Threat Modeling Process](https://owasp.org/www-community/Threat_Modeling_Process) offers a helpful introduction to build your own.
95+
If you're new to this, the [OWASP Threat Modeling Process](https://owasp.org/www-community/Threat_Modeling_Process) offers a helpful introduction to build your own.
9696

9797
Publishing a basic threat model alongside your security policy improves clarity for everyone.
9898

@@ -102,7 +102,7 @@ Publishing a basic threat model alongside your security policy improves clarity
102102
<img src="https://avatars.githubusercontent.com/ulisesgascon?s=180" class="pquote-avatar" alt="avatar">
103103
A vulnerability is basically a flaw, a security misconfiguration or a weak point in our system that can be exploited by third parties to behave in unintended ways.
104104
<p markdown="1" class="pquote-credit">
105-
[@UlisesGascon](https://github.com/ulisesgascon), ["What is a Vulnerability and Whats Not? Making Sense of Node.js and Express Threat Models"](https://gitnation.com/contents/what-is-a-vulnerability-and-whats-not-making-sense-of-nodejs-and-express-threat-models)
105+
[@UlisesGascon](https://github.com/ulisesgascon), ["What is a Vulnerability and What's Not? Making Sense of Node.js and Express Threat Models"](https://gitnation.com/contents/what-is-a-vulnerability-and-whats-not-making-sense-of-nodejs-and-express-threat-models)
106106
</p>
107107
</aside>
108108

@@ -111,18 +111,18 @@ Once you receive a vulnerability report, what happens next?
111111
Having a basic incident response plan, even a simple checklist, helps you stay calm and act efficiently when time matters. It also shows users and researchers that you take reports seriously.
112112

113113
Your process doesn't have to be complex. At minimum, define:
114-
- Who reviews and triages security reports
115-
- How you evaluate severity and decide on mitigation
116-
- What steps you take to prepare a fix and publish a disclosure
117-
- How you notify affected users or contributors, if needed
114+
115+
* Who reviews and triages security reports
116+
* How you evaluate severity and decide on mitigation
117+
* What steps you take to prepare a fix and publish a disclosure
118+
* How you notify affected users or contributors, if needed
118119

119120
Coordinated disclosure works best when there's a clear plan. Publishing this (or linking to it) in your `SECURITY.md` file can help set expectations and build trust.
120121

121122
For inspiration, the [Express.js Security WG](https://github.com/expressjs/security-wg/blob/main/docs/incident_response_plan.md) provides a simple but effective example of an open source incident response plan.
122123

123124
This plan can evolve as your project grows, but having a basic framework in place now can save time and reduce mistakes later.
124125

125-
126126
## Treat security as a team effort
127127

128128
### Security isn't a solo responsibility. It works best when shared across your project's community.
@@ -131,19 +131,19 @@ While tools and policies are essential, a strong security posture comes from how
131131

132132
Here are a few ways to make security a team sport:
133133

134-
- **Assign clear roles**: Know who handles vulnerability reports, who reviews dependency updates, and who approves security patches.
135-
- **Limit access using the principle of least privilege**: Only give write or admin access to those who truly need it and review permissions regularly.
136-
- **Invest in education**: Encourage contributors to learn about secure coding practices, common vulnerability types, and how to use your tools (like SAST or secret scanning).
137-
- **Foster diversity and collaboration**: A heterogeneous team brings a wider set of experiences, threat awareness, and creative problem-solving skills. It also helps uncover risks others might overlook.
138-
- **Engage upstream and downstream**: Your dependencies can affect your security and your project affects others. Participate in coordinated disclosure with upstream maintainers, and keep downstream users informed when vulnerabilities are fixed.
134+
* **Assign clear roles**: Know who handles vulnerability reports, who reviews dependency updates, and who approves security patches.
135+
* **Limit access using the principle of least privilege**: Only give write or admin access to those who truly need it and review permissions regularly.
136+
* **Invest in education**: Encourage contributors to learn about secure coding practices, common vulnerability types, and how to use your tools (like SAST or secret scanning).
137+
* **Foster diversity and collaboration**: A heterogeneous team brings a wider set of experiences, threat awareness, and creative problem-solving skills. It also helps uncover risks others might overlook.
138+
* **Engage upstream and downstream**: Your dependencies can affect your security and your project affects others. Participate in coordinated disclosure with upstream maintainers, and keep downstream users informed when vulnerabilities are fixed.
139139

140140
Security is an ongoing process, not a one-time setup. By involving your community, encouraging secure practices, and supporting each other, you build a stronger, more resilient project and a safer ecosystem for everyone.
141141

142142
## Conclusion: A few steps for you, a huge improvement for your users
143143

144144
These few steps might seem easy or basic to you, but they go a long way to make your project more secure for its users, because they will provide protection against the most common issues.
145145

146-
Security isnt static. Revisit your processes from time to time as your project grows, so do your responsibilities and your attack surface.
146+
Security isn't static. Revisit your processes from time to time as your project grows, so do your responsibilities and your attack surface.
147147

148148
## Contributors
149149

0 commit comments

Comments
 (0)