Documentation
Contributing to Everlock
Everlock is an open source project. The useful form of openness here is not just “patches welcome”, but a codebase and public site that try to make the system understandable before someone starts changing it.
Project links
- Repository: https://codeberg.org/JensWalter/everlock
- Issues: https://codeberg.org/JensWalter/everlock/issues
- Architecture: Architecture
- Docs hub: Docs
What good contributions look like
- changes that respect the frontend/backend split
- docs that clarify real behavior
- tests around routing, storage, access control, and site rendering
- work on backend families that are still partial or not yet wired end-to-end
- small patches that improve one layer without leaking into another
Important project rule
Core functionality must stay in-process.
That means no spawning git, sh, or other helper binaries for production behavior. If a feature needs external tooling today, the expected direction is to embed that behavior with a Rust library or raise the design question first.
A good way to get oriented
- Read the relevant architecture or backend page first.
- Confirm which crate should own the behavior.
- Check whether the feature is already documented as implemented, partial, or planned.
- Make the smallest change that improves the public contract or code behavior.
Good starting areas
- documentation and examples
- tests and rendering fixes
- backend families that already have a clear design shape
- status-table cleanup when implementation reality changes