More Guide
Send a change to Local Link, or get help using it. What a contribution is licensed under, and where each part of the work is explained, is on More.
Developing
Build, run, test and ship a change to Local Link: Developing. Every program in Local Link is written in Rust, with native executables: Built in Rust.
Send a change
For anything bigger than a fix, open an issue before writing it.
- Where things go: Architecture has the layout, the dependency rules (a test enforces them) and a table of where new code goes. Conventions has the rules every change follows.
- Building, testing and the checks to run before pushing: Developing, and The Website for the website.
- Branches and pull requests: Branches and Releases.
- New dependencies must be permissively licensed.
tests/repository/tests/licenses.rslists what's accepted. - Conduct follows the Contributor Covenant.
Getting help
Start with the docs, and open an issue for a bug or an idea.
- Using Link: start with Install, then the page of the part you use.
- Something broken: run
lnk issue createafter the command that failed. It prints the bug report's fields, scrubbed of your names, paths, addresses and anything shaped like a secret, to read and paste;lnk issue create --openfills them in on the form. Link sends nothing itself. - An idea: open a feature request.
- A security problem: never an issue. See Report a Vulnerability.