Skip to content

Commit 20d74c0

Browse files
Add a "consider" line or users (#874)
The text for component creators starts with "Consider". This commit adds similar text to start the list for component users. I think this is important, as there are cases where you shouldn't blindly do something, but you *should* consider things. It also makes the document a little more consistent. Signed-off-by: David A. Wheeler <[email protected]>
1 parent 1732def commit 20d74c0

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

docs/Simplifying-Software-Component-Updates.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,8 @@ Consider the following whenever making changes that might change the component
4747

4848
## Component Users
4949

50+
Consider the following when developing and maintaining software with dependencies:
51+
5052
1. **Be cautious when adding dependencies.** Before adding a dependency, check if the functionality you need is already available in your existing dependencies or standard library. Every dependency introduces maintenance burden, and may become unmaintained and/or introduce security risks. [Evaluate](https://best.openssf.org/Concise-Guide-for-Evaluating-Open-Source-Software) each dependency based on its quality, maintenance, and security. While avoiding adding a new dependency reduces supply chain risk, there is an inherent risk in reinventing the wheel – the code you write will almost certainly have bugs and potential security vulnerabilities. A well-maintained and widely used library will likely be more robust and secure than writing your own implementation*.*
5153
2. **Configure dependencies so you only use what you need.** Some components make it easy to load only part (e.g., through a plug-in architecture or configuration). It’s hard to exploit code that isn’t there or can’t be executed.
5254
3. **Use package manager(s) to track dependencies and enable automated updates**. Most modern systems have too many dependencies to manage manually.

0 commit comments

Comments
 (0)