-
Notifications
You must be signed in to change notification settings - Fork 12
Description
Description
Create two foundational documentation files—GLOSSARY.md and GOVERNANCE.md—to improve onboarding, clarity, and long-term sustainability of the Bridgelet project.
These documents should help:
New users and developers understand Bridgelet- and Stellar-specific terminology
Contributors understand how decisions are made and how they can participate in shaping the project
Both documents should be written clearly, concisely, and structured for future expansion as the project evolves.
Part 1: GLOSSARY.md
Purpose
Provide a centralized glossary of terms used throughout Bridgelet and the Stellar ecosystem to reduce confusion and improve onboarding.
Requirements
Create GLOSSARY.md under /docs
Define at least 20 terms
Organize terms alphabetically
Keep definitions clear and concise
Include examples where helpful
Cross-reference related terms where applicable
Link glossary from the Getting Started documentation
Some Terms to Define
Ephemeral account
Sweep / Auto-sweep
Claim token
Claim URL
Recovery address
Expiry / Expiration
Funding account
Destination wallet
Horizon
Soroban
Smart contract
XLM (Lumens)
Stellar account
Trustline
Asset issuer
Base reserve
Ledger
(Additional relevant terms may be added if helpful.)
Part 2: GOVERNANCE.md
Purpose
Document how the Bridgelet project is governed to ensure transparency, clarity, and inclusive participation.
Requirements
- Create GOVERNANCE.md at /docs, (consistent with repo structure)
- Clearly describe the governance model and decision-making process
- Governance Topics to Cover
- Governance Structure
- Project maintainers and their roles
Contributor levels:
- Contributor
- Committer
- Maintainer
- How to become a maintainer
- Decision-Making
- How proposals are made
- How decisions are approved
- Voting procedures (if applicable)
- How roadmap priorities are determined
- Project Operations
- Release management process
- Conflict resolution process
- Communication channels used for governance
- Meeting cadence (if any)
Acceptance Criteria
GLOSSARY
- docs/GLOSSARY.md exists
- At least 20 terms defined
- Alphabetically organized
- Clear definitions with examples where useful
- Cross-referenced with other documentation
- Linked from Getting Started guide
GOVERNANCE
- docs/GOVERNANCE.md exists
- Roles and responsibilities clearly defined
- Decision-making process documented
- Maintainer promotion process defined
- Conflict resolution outlined
- Governance is transparent and inclusive
- Linked from CONTRIBUTING.md
Notes
- Content should reflect the current state of the project, with room for future updates.
- Where processes are still evolving, clearly note them as initial or subject to change.
Contact me here or in telegram (usename: teemahbee) or discord (username: @teemahbbee. ) for more information or any question about the project.