19 lines
975 B
Markdown
19 lines
975 B
Markdown
# Contributing
|
|
|
|
Describe reproducible problems and proposed changes in an issue or pull request.
|
|
Include the version, command, expected and actual results. Remove credentials
|
|
and sensitive paths from shared logs.
|
|
|
|
Run [development checks](docs/development.md), keep changes focused, use
|
|
`cargo fmt`, and add regression tests for changed behavior. Explain relevant
|
|
RFC/WG requirements and update documentation when interfaces change.
|
|
|
|
Documentation and code comments use English. Do not commit generated repository
|
|
objects, keys, state, logs or build outputs. Keep third-party attribution intact.
|
|
Submit only code you are entitled to contribute under the [project license](LICENSE)
|
|
and identify externally sourced code and its license in the pull request.
|
|
|
|
Use the [security policy](SECURITY.md) for suspected vulnerabilities, not public
|
|
issues. Changes to Cargo.lock must update and check dependency notices using
|
|
the [dependency maintenance workflow](docs/dependencies.md).
|