Contributor's Guide
Last updated
Was this helpful?
Last updated
Was this helpful?
Welcome to the Trustless Work open-source community! 🚀 We appreciate your interest in contributing and helping us build Escrow Infrastructure for the New Economy. This guide will walk you through the process of contributing effectively.
If you want to contribute and get rewarded, apply through on Only Dust. Only Dust makes life easier for maintainers since it handles rewards for us. You might (or might not :( ) get rewarded and it is not in our hands. Stellar sponsors OD Campaigns and the rewards come from them. Thanks Stellar!
Once assigned a task, please follow these guidelines:
Fork the repository on GitHub.
Clone your forked repository to your local machine:
Set the upstream remote to sync with the main repo:
Ensure you're on the latest version of develop
:
We follow a structured branching model to keep contributions organized.
main
→ The production-ready branch (DO NOT push here directly).
develop
→ The active development branch where features are merged.
Create a branch based on the type of change:
Features: feat/feature-name
Example: feat/escrow-ui
Bug Fixes: fix/bug-description
Example: fix/api-response-error
Documentation: docs/update-name
Example: docs/getting-started-guide
Refactoring: refactor/code-improvement
Example: refactor/clean-smart-contracts
Always create a new branch before making changes:
✅ Keep changes small and atomic. ✅ Follow commit message guidelines (see below). ✅ Ensure tests pass before submitting a PR. ✅ Format code using our linting and formatting rules.
Use a clear and concise commit message format:
Examples:
feat: add escrow approval system
fix: resolve API timeout issue
docs: update README with setup instructions
Types:
feat
: New feature
fix
: Bug fix
docs
: Documentation update
refactor
: Code restructuring
style
: Code formatting (no logic changes)
test
: Adding or updating tests
build
: Changes to build process or dependencies
ci
: Changes to CI/CD setup
chore
: Miscellaneous updates
Go to the original repo on GitHub.
Click New Pull Request.
Select develop
as the base branch and your feature branch as the compare branch.
Provide a clear description of the changes.
Submit for review!
✅ Maintainers will review the PR and provide feedback.
✅ If requested, make changes and push updates to your PR.
✅ Once approved, the PR is merged into develop
.
✅ After testing, develop
is merged into main
for production.
Happy coding! 🎉
📖 – Browse our repositories. 💬 – Connect with other contributors.