hashgraph / hashgraph/hedera-sdk-reference
Develop guidelines on best practices
- Dominant language
- HTML
- Stars
- 7
- Forks
- 3
- PR merge metrics
- No merged PRs in 30d
Description
We should develop guidelines that outline our goals and the best practices we as a team wish to adhere to. Topics that should be included in these guidelines include (but is not limited to) the following:
* Semantic versioning:
* Deprecation and removal of API.
* The introduction of new API.
* Cross-language versioning consistency versus each language versioning at its own pace.
* Breaking change policy and the introduction of tooling to prevent any accidental (or intentional-without-prior-approval) changes.
* Build tooling and expectations - minimum levels of code coverage, getting code linters (e.g. spotbugs, etc) issues to zero.
* Documentation expectations - how often we should generate the actual reference output and review it for quality, missing samples, etc.
* Repository expectations:
* Pull requests needing to be reviewed / approved by another developer.
* Common design patterns
Contributor guide
Assessment
This issue has not been assessed yet.