Skip to content

Commit 07fbe8c

Browse files
foundation: add library tiers page
1 parent 67f7a7b commit 07fbe8c

File tree

2 files changed

+95
-0
lines changed

2 files changed

+95
-0
lines changed

docs/.vuepress/config.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ const foundationSidebar = [
3333
children: [
3434
['/foundation/about.md', 'About Us'],
3535
['/foundation/members.md', 'Members'],
36+
['/foundation/libraries.md', 'Our Libraries'],
3637
['/foundation/grantees.md', 'Grantees'],
3738
['/foundation/grants.md', 'Grants'],
3839
['/foundation/pgp.md', 'PGP Keys'],

docs/foundation/libraries.md

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
---
2+
sidebar: true
3+
tagline: "Foundation"
4+
description: "The libraries we maintain."
5+
prev: false
6+
next: false
7+
editLink: false
8+
lastUpdated: false
9+
---
10+
11+
# Our Libraries
12+
13+
The primary purpose of the Foundation is to:
14+
15+
1. advance the Bitcoin software development industry by fostering innovation, promoting best practices, and improving the overall ecosystem;
16+
2. support the promotion, research, development, maintenance, and security of the Bitcoin Dev Kit (BDK) libraries and other projects supporting the Bitcoin software industry (the "Projects");
17+
3. support and empower Bitcoin software developers through educational initiatives, open-source project support, and industry-wide collaboration;
18+
4. manage the technical infrastructure underlying the development of the Projects;
19+
5. manage and steward the BDK trademark and other assets of the Foundation;
20+
6. undertake such other activities as may from time to time be appropriate to further the purposes and achieve the goals set forth above.
21+
22+
In furtherance of these efforts, the Foundation shall seek to solicit the participation of all interested parties on a fair, equitable, and open basis.
23+
24+
To these ends we provide the technical infrastructure to maintain a number of software projects across different maturity levels. To help you navigate these projects we've categorized them into three distinct groups.
25+
26+
## Library Categories
27+
28+
### The `Foundational` Tier
29+
30+
The libraries that form the core of the BDK ecosystem. These repositories receive the highest level of attention and maintenance.
31+
32+
**What to expect:**
33+
34+
- Two official maintainers
35+
- Maintainers are supported by grant funding from the BDK Foundation
36+
- A robust community of users and volunteer maintainers
37+
- Comprehensive test coverage and CI/CD
38+
- Security updates and dependency maintenance
39+
- Security updates back ported to prior major release
40+
- Active monitoring and fast response to issues
41+
- Semantic versioning with clear release notes
42+
- Data schema stability guarantees and clear migration paths
43+
- Extensive documentation (API, tutorials, guides, etc.) with code examples
44+
- Example applications
45+
46+
### The `Community` Tier
47+
48+
Well-maintained libraries that serve more specific use cases and see less frequent updates. These repositories rely more on community contributions for maintenance.
49+
50+
**What to expect:**
51+
52+
- Two official maintainers
53+
- Maintained by volunteers from the community
54+
- Maintainers may receive grant funding from the BDK Foundation
55+
- A robust community of users and volunteer maintainers
56+
- Comprehensive test coverage and CI/CD
57+
- Security updates and dependency maintenance
58+
- Semantic versioning with clear release notes
59+
- Response to issues within a reasonable timeframe
60+
- Documentation (API) with code examples
61+
62+
### The `Experimental` Tier
63+
64+
Early-stage projects. These may be unstable or undergoing rapid iteration. These projects aim to over time become either `Foundational` or `Community` projects, but are not yet ready.
65+
66+
**What to expect:**
67+
68+
- At least one official maintainer
69+
- Maintained by volunteers from the community
70+
- Incomplete or evolving APIs
71+
- Only basic test coverage and CI/CD
72+
- Limited or no backward compatibility guarantees
73+
- Minimal documentation
74+
- Potential for major changes or deprecation
75+
76+
## Table
77+
78+
| | Foundational | Community | Experimental |
79+
|------------------------------------|:------------:|:---------:|:------------:|
80+
| Maintainers | 2 | 2 | 1 |
81+
| BDKF Grant Funding | Yes | Optional | No |
82+
| Community Support | Yes | Yes | No |
83+
| Comprehensive Testing and CI/CD | Yes | Yes | No |
84+
| Security and Dependency Updates | Yes | Yes | No |
85+
| Semantic Versioning, Release Notes | Yes | Yes | No |
86+
| API Documentation, Code Examples | Yes | Yes | No |
87+
| Back-ported Security Updates | Yes | No | No |
88+
| Fast Response to Issues | Yes | No | No |
89+
| Data Schema Stability, Migration | Yes | No | No |
90+
| Tutorials, Guides, Example Apps | Yes | No | No |
91+
92+
## Where to Find This Information
93+
94+
You can find the tiers assigned to each library in our [GitHub Org](https://github.com/bitcoindevkit) under the [Libraries heading](https://github.com/bitcoindevkit#our-core-libraries). There you'll also find information on the specific maintainers assigned to each library.

0 commit comments

Comments
 (0)