CodingGuidelines

Code Review Guidelines

This page collects the set of style guides that Go code in aries-framework-go adheres to.

Principles

We have adopted the best practices that have been documented in the community by default. Any deviations from the norms are documented below as Exceptions.

Additional topics not well-documented by the community are covered in Additional Cases.

Community Best Practices

All best practices described by the following communities are formally adopted into these guidelines:

• GoCodeReviewComments
• Effective Go
• Dave Cheney

Exceptions

N/A

Additional Cases

"Not Found"

Discussion: #127

"Not Found" is a scenario where a function does not find a result that matches the input criteria while not encountering any "abnormal" error conditions. Our APIs in these cases return a Sentinel Error Value.

Optional Parameters

Discussion: #127

We use functional optional parameters in cases where parameters are optional and have sensible defaults.