-
Notifications
You must be signed in to change notification settings - Fork 2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add policy for consuming and upgrading dependencies
Signed-off-by: Ricardo Lopes <[email protected]>
- Loading branch information
1 parent
d8dd6e0
commit 8c75a8b
Showing
2 changed files
with
45 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
# Dependencies Policy | ||
|
||
## Purpose | ||
|
||
This policy describes how kube-state-metrics maintainers consume third-party packages. | ||
|
||
## Scope | ||
|
||
This policy applies to all kube-state-metrics maintainers and all third-party packages used in the kube-state-metrics project. | ||
|
||
## Policy | ||
|
||
kube-state-metrics maintainers must follow these guidelines when consuming third-party packages: | ||
|
||
- Only use third-party packages that are necessary for the functionality of kube-state-metrics. | ||
- Use the latest version of all third-party packages whenever possible. | ||
- Avoid using third-party packages that are known to have security vulnerabilities. | ||
- Pin all third-party packages to specific versions in the kube-state-metrics codebase. | ||
- Use a dependency management tool, such as Go modules, to manage third-party dependencies. | ||
|
||
## Procedure | ||
|
||
When adding a new third-party package to kube-state-metrics, maintainers must follow these steps: | ||
|
||
1. Evaluate the need for the package. Is it necessary for the functionality of kube-state-metrics? | ||
2. Research the package. Is it actively maintained? Does it have a good reputation? | ||
3. Choose a version of the package. Use the latest version whenever possible. | ||
4. Pin the package to the specific version in the kube-state-metrics codebase. | ||
5. Update the kube-state-metrics documentation to reflect the new dependency. | ||
|
||
## Enforcement | ||
|
||
This policy is enforced by the kube-state-metrics maintainers. | ||
|
||
Maintainers are expected to review each other's code changes to ensure that they comply with this policy. | ||
|
||
## Exceptions | ||
|
||
Exceptions to this policy may be granted by the kube-state-metrics project owners on a case-by-case basis. | ||
|
||
## Credits | ||
|
||
This policy was adapted from Kubescape's [Environment Dependencies Policy](https://github.com/kubescape/kubescape/blob/master/docs/environment-dependencies-policy.md). |