Skip to content

Commit 38bed6f

Browse files
authored
add Dependencies policy and Security policy (#934)
Signed-off-by: yangshiqi <[email protected]>
1 parent 7e68c92 commit 38bed6f

File tree

2 files changed

+86
-0
lines changed

2 files changed

+86
-0
lines changed

DEPENDENCY.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Environment Dependencies Policy
2+
3+
## Purpose
4+
5+
This policy establishes guidelines for managing third-party packages in the HAMi repository. Its goal is to ensure that all dependencies are secure, up-to-date, and necessary for the project’s functionality.
6+
7+
## Scope
8+
9+
This policy applies to all maintainers of the HAMi repository and governs all third-party packages incorporated into the project.
10+
11+
## Policy
12+
13+
Maintainers must adhere to the following when incorporating third-party packages:
14+
15+
- **Necessity:** Include only those packages that are essential to the project’s functionality.
16+
- **Latest Stable Versions:** Use the latest stable releases whenever possible.
17+
- **Security:** Avoid packages with known security vulnerabilities.
18+
- **Version Pinning:** Lock all dependencies to specific versions to maintain consistency.
19+
- **Dependency Management:** Utilize an appropriate dependency management tool (e.g., Go modules, npm, pip) to handle third-party packages.
20+
- **Testing:** Ensure that any new dependency passes all automated tests before integration.
21+
22+
## Procedure
23+
24+
When adding a new third-party package, maintainers should:
25+
26+
1. **Assess Need:** Determine whether the package is truly necessary for the project.
27+
2. **Conduct Research:** Review the package’s maintenance status and reputation within the community.
28+
3. **Select Version:** Opt for the latest stable version that meets the project’s requirements.
29+
4. **Pin the Version:** Explicitly pin the dependency to the chosen version within the repository.
30+
5. **Update Documentation:** Revise the project documentation to include details about the new dependency.
31+
32+
## Archive/Deprecation
33+
34+
If a third-party package becomes deprecated or discontinued, maintainers must promptly identify and integrate a suitable alternative while updating the documentation accordingly.
35+
36+
## Enforcement
37+
38+
Compliance with this policy is monitored by the HAMi maintainers. All dependency-related changes are subject to peer review to ensure adherence to these guidelines.
39+
40+
## Exceptions
41+
42+
Exceptions to this policy may be granted by the HAMi project lead on a case-by-case basis. Any exceptions must be documented with a clear rationale.
43+
44+
## Credits
45+
46+
This policy has been adapted and optimized based on guidelines from the [Kubescape Community](https://github.com/kubescape/kubescape/blob/master/docs/environment-dependencies-policy.md).

SECURITY.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
The following table outlines which versions of HAMi receive security updates:
6+
7+
| Version | Supported |
8+
|---------|--------------------|
9+
| 2.5.x | ✅ Security fixes |
10+
| 2.4.x | ✅ Security fixes |
11+
| before 2.4.0 | ❌ No longer supported |
12+
13+
## Reporting a Vulnerability
14+
15+
If you discover a security vulnerability in HAMi, we strongly encourage you to report it responsibly. Please **do not** disclose security vulnerabilities publicly without following our responsible disclosure process.
16+
17+
### How to Report
18+
- **GitHub Security Advisories**: [submit a private vulnerability report via GitHub](https://github.com/Project-HAMi/HAMi/security/advisories/new).
19+
- **Bug Bounty**: Currently, HAMi does not offer a public bug bounty program.
20+
21+
### Information to Include
22+
When reporting a security issue, please include:
23+
- A clear and concise description of the vulnerability.
24+
- Steps to reproduce the issue.
25+
- Any potential attack scenarios or security impact.
26+
- Suggested mitigations or fixes, if available.
27+
28+
## Response Process
29+
30+
We follow a structured process to handle security reports:
31+
32+
Response times could be affected by weekends, holidays, breaks or time zone differences. That said, the maintainers will endeavour to reply as soon as possible, ideally within 5 working days.
33+
34+
35+
## Third-Party Dependencies
36+
37+
HAMi relies on third-party libraries and containers. We monitor dependencies and promptly apply security patches.
38+
39+
40+
Thank you for helping us make HAMi more secure! 🔒

0 commit comments

Comments
 (0)