elektrine/elektrine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
elektrine/CONTRIBUTING.md
Maxfield Luke 454e80a8f8
Some checks failed
Deploy Docker Images / Build, push, and deploy (push) Failing after 19m8s
Details
Smoke / Hello from Forgejo Actions (push) Successful in 1s
Details
Initial commit 
Fresh repository on git.elektrine.com/elektrine/elektrine.
2026-07-30 01:36:18 -04:00

1.2 KiB
Raw Blame History

Contributing

Thanks for contributing to Elektrine.

Scope

This repository is an umbrella project. All apps in apps/ are open source under the same root LICENSE:

  • apps/elektrine
  • apps/elektrine_web
  • apps/arblarg
  • apps/elektrine_email
  • apps/elektrine_social
  • apps/elektrine_vpn
  • apps/elektrine_nerve
  • apps/elektrine_dns

License

This repository is licensed under AGPL-3.0-only (see LICENSE). By contributing, you agree that your contributions are provided under that same license.

Development Setup

  1. Install Elixir/Erlang and PostgreSQL.
  2. Clone the repo.
  3. Copy env/dev.env.example to .env and set local values.
  4. Run setup:
mix setup
  1. Start the app:
cd apps/elektrine
mix phx.server

Running Checks

Run these before opening a PR:

mix check

Pull Requests

  1. Keep PRs focused and small.
  2. Include tests for behavior changes.
  3. Update docs when behavior/config changes.
  4. Fill out the PR template.

Commit Style

Use clear, imperative commit messages, for example:

  • Add federation outbox retry worker
  • Fix sequence gap recovery for messaging events

Security

Do not open public issues for vulnerabilities. Use the process in SECURITY.md.