First off, thank you for contributing to tlsn.
If your contribution is not straightforward, please first discuss the change you wish to make by creating a new issue.
Before reporting an issue on the issue tracker, please check that it has not already been reported by searching for some related keywords.
Try to do one pull request per change.
Before a Pull Request (PR) can be merged, the Continuous Integration (CI) pipeline automatically lints all code using Clippy. To ensure your code is free of linting issues before creating a PR, run the following command:
cargo clippy --all-features --all-targets -- -D warningsThis command will lint your code with all features and targets enabled, and treat any warnings as errors, ensuring that your code meets the required standards.
This repository includes a rustfmt.toml file with custom formatting settings that are automatically validated by CI before any Pull Requests (PRs) can be merged. To ensure your code adheres to these standards, format your code using this configuration before submitting a PR. We strongly recommend enabling auto format on save to streamline this process. In Visual Studio Code (VSCode), you can enable this feature by turning on editor.formatOnSave in the settings.
Both line comments and doc comments must be capitalized. Each sentence must end with a period.
// This is a line comment.
We recommend a soft comment line length limit of 100 characters. Authors should aim to wrap lines before hitting this limit, but it is not a hard limit. Comments are allowed to exceed this limit.
Comments describing a function usually start with a verb. That verb must use the third-person present tense, e.g. "Creates", "Sets", "Computes".
Comments for function arguments must adhere to this pattern:
/// Performs a certain computation. Any other description of the function.
///
/// # Arguments
///
/// * `arg1` - The first argument.
/// * `arg2` - The second argument.
pub fn compute(...