contributing
============
We are all living beings, and what is most important is that we respect each other and work together. If you can not uphold this simple standard, then your contributions are not welcome.
## hacking
Just a few simple items to keep in mind as you hack.
- Pull request early and often. This helps to let others know what you are working on. **Please use GitHub's Draft PR mechanism** if your PR is not yet ready for review.
- Use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/), a changelog will automatically be created from such commits
- When making changes to the configuration, be sure to regenerate the schema. This can be done by running:
```shell
cargo run -- config generate-schema schemas/config.json
```
## linting
We are using clippy & rustfmt. Clippy is SO GREAT! Rustfmt ... has a lot more growing to do; however, we are using it for uniformity.
Please be sure that you've configured your editor to use clippy & rustfmt, or execute them manually before submitting your code. CI will fail your PR if you do not.
## release workflow
We follow [semver](https://semver.org/spec/v2.0.0.html) for versioning this system.
- [ ] update `Cargo.toml` `version` & execute `cargo update` — this ensures that the `Cargo.lock` doesn't update during CI due to the new version number, which will cause CI failure.
- [ ] ensure CI completes successfully.
- [ ] add a new tag to the repo matching the new `Cargo.toml` `version`. Either via `git tag` or via the Github UI.
- all release tags should start with the letter `v` followed by a semver version.
- [ ] CI is configured for release tags and will create a new GitHub release, and will upload release artifacts to the release page. Verify that this process has completed successfully.
## SSL
Trunk supports `native-tls`, `rustls` with ring, or `rustls` with AWS-LC for TLS. Exactly one backend must be enabled and is used consistently for HTTP clients, WebSocket clients, and the development server. Local Cargo builds default to rustls with ring, while release artifacts use `native-tls`.
The native TLS server requires its PEM private key to use PKCS#8 encoding (`BEGIN PRIVATE KEY`).
To opt into native TLS, disable the default features and select it explicitly:
```sh
cargo build --no-default-features -F update_check,native-tls
```
To opt into rustls with AWS-LC, use:
```sh
cargo build --no-default-features -F update_check,rustls-aws-lc
```
The `vendored` feature vendors dependencies used by `native-tls` when supported.