Contributing

Local Link is licensed under either of MIT or Apache-2.0, at your option. Unless you say otherwise, any contribution you send is licensed the same way, under both, with no additional terms.

  • Where things go: Architecture has the layout, the dependency rules (a test enforces them) and a table of where new code goes; Conventions, the rules every change follows. For anything bigger than a fix, open an issue before writing it.
  • Building, testing, and the checks to run before pushing: docs/en/dev, and the website's for the website.
  • Branches and pull requests: Branches and releases.
  • New dependencies must be permissively licensed: src/tests/e2e/tests/licenses.rs lists what's accepted.
  • Security problems are never issues or PRs: report them privately, as Report a Vulnerability says.
  • Conduct: the Contributor Covenant.

The names "Local Link" and "local.link" and the hosted service at local.link are not covered by the license. You are welcome to run your own relay (src/server/deploy) under your own domain; please don't present a fork as the official service.

Getting help