Skip to content

Commit 8f71e2d

Browse files
committed
chore: add GOVERNANCE.md for open source
Ticket: WP-5840
1 parent 23a1d2b commit 8f71e2d

File tree

1 file changed

+48
-0
lines changed

1 file changed

+48
-0
lines changed

GOVERNANCE.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Advanced Wallets Governance Model
2+
3+
## 1. Introduction
4+
5+
This document defines the governance model for the BitGo Advanced Wallets open source project. It outlines the roles, rules for participation, and decision-making processes to ensure the project remains secure and transparent.
6+
7+
## 2. Project Goals and Values
8+
9+
The decision to open source this project is driven by several key objectives, all rooted in transparency, security, and community benefit.
10+
11+
- **Security and Audits**: The primary goal is to enable the community to perform security audits. Open-sourcing all components provides full transparency and an auditable history of the codebase, which is critical for identifying vulnerabilities and ensuring a high level of security.
12+
13+
- **On-Premise Adoption**: We aim to promote the adoption of on-premise hot wallet setups. This project serves as a toolkit and example for users and services to integrate their own Hardware Security Modules (HSMs) or Key Management Systems (KMSs) for user and backup key management.
14+
15+
## 3. Roles and Responsibilities
16+
17+
### Contributors
18+
19+
Any individual or organization can become a contributor. Contributors can submit code, documentation, and other changes through pull requests. The ability to contribute is open to everyone, regardless of their affiliation.
20+
21+
### Maintainers
22+
23+
The maintainers are individuals designated to review and approve contributions. They are responsible for ensuring the quality, security, and integrity of the project's codebase. For this project, a Maintainer is a member of the core BitGo team.
24+
25+
## 4. Contribution and Review Process
26+
27+
- All contributions must be submitted via a pull request to the main repository.
28+
- A contribution is considered ready for merging only after it has been reviewed and approved by **at least two designated Maintainers**.
29+
- The Maintainers will review the contribution for correctness, security implications, code quality, and alignment with the project's goals.
30+
- Contributors are expected to be responsive to feedback from Maintainers to ensure a smooth review process.
31+
32+
## 5. Decision Making
33+
34+
### Consensus-Based for Core Changes
35+
36+
For significant changes to the project's architecture, roadmap, or governance, Maintainers will work toward a consensus.
37+
38+
### Maintainer Discretion
39+
40+
For standard pull requests, the final decision to merge rests with the Maintainers. Their role is to uphold the security and quality standards of the project.
41+
42+
## 6. Communication
43+
44+
- **GitHub Issues**: All bugs, feature requests, and technical discussions should be held on the project's GitHub issues page to ensure transparency and a public record.
45+
46+
- **Pull Request Comments**: All feedback and discussions related to specific code changes should take place directly on the pull request.
47+
48+
- **Support**: For general support, reach out to [[email protected]](mailto:[email protected]).

0 commit comments

Comments
 (0)