44210c350b
* fix: miscellaneous fixes on documentation, notary-server. * Revert notary changes. * Add warning when TLS is off.
1.3 KiB
Contribution guidelines
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.
Reporting issues
Before reporting an issue on the issue tracker, please check that it has not already been reported by searching for some related keywords.
Pull requests
Try to do one pull request per change.
Style
Capitalization and punctuation
Both line comments and doc comments must be capitalized. Each sentence must end with a period.
// This is a line comment.
Avoid overly long comment lines
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.
Verbs in function description
Comments describing a function usually start with a verb. That verb must use the third-person present tense, e.g. "Creates", "Sets", "Computes".
Function arguments
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(...