Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ const foundationSidebar = [
children: [
['/foundation/about.md', 'About Us'],
['/foundation/members.md', 'Members'],
['/foundation/libraries.md', 'Our Libraries'],
['/foundation/grantees.md', 'Grantees'],
['/foundation/grants.md', 'Grants'],
['/foundation/pgp.md', 'PGP Keys'],
Expand Down
94 changes: 94 additions & 0 deletions docs/foundation/libraries.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
---
sidebar: true
tagline: "Foundation"
description: "The libraries we maintain."
prev: false
next: false
editLink: false
lastUpdated: false
---

# Our Libraries

The primary purpose of the Foundation is to:

1. advance the Bitcoin software development industry by fostering innovation, promoting best practices, and improving the overall ecosystem;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should these 1-6 first letter be uppercased

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");
3. support and empower Bitcoin software developers through educational initiatives, open-source project support, and industry-wide collaboration;
4. manage the technical infrastructure underlying the development of the Projects;
5. manage and steward the BDK trademark and other assets of the Foundation;
6. undertake such other activities as may from time to time be appropriate to further the purposes and achieve the goals set forth above.

In furtherance of these efforts, the Foundation shall seek to solicit the participation of all interested parties on a fair, equitable, and open basis.

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.

## Library Categories

### The `Foundational` Tier

The libraries that form the core of the BDK ecosystem. These repositories receive the highest level of attention and maintenance.

**What to expect:**

- Two official maintainers
- Maintainers are supported by grant funding from the BDK Foundation
- A robust community of users and volunteer maintainers
- Comprehensive test coverage and CI/CD
- Security updates and dependency maintenance
- Security updates back ported to prior major release
- Active monitoring and fast response to issues
- Semantic versioning with clear release notes
- Data schema stability guarantees and clear migration paths
- Extensive documentation (API, tutorials, guides, etc.) with code examples
- Example applications

### The `Community` Tier

Well-maintained libraries that serve more specific use cases and see less frequent updates. These repositories rely more on community contributions for maintenance.

**What to expect:**

- Two official maintainers
- Maintained by volunteers from the community
- Maintainers may receive grant funding from the BDK Foundation
- A robust community of users and volunteer maintainers
- Comprehensive test coverage and CI/CD
- Security updates and dependency maintenance
- Semantic versioning with clear release notes
- Response to issues within a reasonable timeframe
- Documentation (API) with code examples

### The `Experimental` Tier

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.

**What to expect:**

- At least one official maintainer
- Maintained by volunteers from the community
- Incomplete or evolving APIs
- Only basic test coverage and CI/CD
- Limited or no backward compatibility guarantees
- Minimal documentation
- Potential for major changes or deprecation

## Table

| | Foundational | Community | Experimental |
|------------------------------------|:------------:|:---------:|:------------:|
| Maintainers | 2 | 2 | 1 |
| BDKF Grant Funding | Yes | Optional | No |
| Community Support | Yes | Yes | No |
| Comprehensive Testing and CI/CD | Yes | Yes | No |
| Security and Dependency Updates | Yes | Yes | No |
| Semantic Versioning, Release Notes | Yes | Yes | No |
| API Documentation, Code Examples | Yes | Yes | No |
| Back-ported Security Updates | Yes | No | No |
| Fast Response to Issues | Yes | No | No |
| Data Schema Stability, Migration | Yes | No | No |
| Tutorials, Guides, Example Apps | Yes | No | No |

## Where to Find This Information

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.
Loading