Relay's Obsidian plugin is MIT licensed and developed in the open so users can inspect and audit the code they install. Transparency and trust are the primary goals of this repository.
The best place to start is the Relay Discord: Join our Discord. Please discuss an idea there before opening a large pull request or starting work on a behavior change.
We can usually review small, focused pull requests, especially:
- Typo and documentation fixes
- Small UI polish
- Narrowly scoped bug fixes with clear reproduction steps
- Small improvements to tests or developer ergonomics
Keep pull requests easy to evaluate. Include what changed, why it changed, and how you tested it.
Please talk to us in Discord before working on:
- New product features
- Protocol, sync, merge, auth, permissions, or billing behavior
- Large refactors
- Changes that require server support
- Changes that affect data durability, privacy, encryption, or account access
We probably will not accept large pull requests that arrive without prior discussion, even if the code is good. Relay has product constraints and private infrastructure that may not be obvious from this repository.
Relay has a proprietary development harness and test suite that is not publicly available. The unit tests included in this repository are encrypted. If you are interested in licensing our technology, please contact us.
For questions, support, feature ideas, and early design discussion, use the Relay Discord.
For responsible security disclosures, email security@system3.md.
By submitting code, documentation, or other changes to this repository, you agree that your contribution may be distributed under the repository's MIT license.