[Docs] Add code review keywords for nits, techdebt, and show stoppers - Githubissues

pokt-network / pocket

Official implementation of the Pocket Network Protocol v1

https://pokt.network

MIT License

61 stars 33 forks source link

[Docs] Add code review keywords for nits, techdebt, and show stoppers #828

Closed dylanlott closed 1 year ago

dylanlott commented 1 year ago

Description

Adds recommended keywords NIT, TECHDEBT, and SOS for use during review to signal next steps for the author.

Summary generated by Reviewpad on 21 Jun 23 02:34 UTC

This pull request adds new code review keywords for nits, techdebt, and show stoppers to the CODE_REVIEW_GUIDELINES.md file. It also updates the formatting and provides additional guidelines for Pull Request approval.

Issue

Stacks on top of #773

Type of change

Please mark the relevant option(s):

[ ] New feature, functionality or library
[ ] Bug fix
[ ] Code health or cleanup
[ ] Major breaking change
[x] Documentation
[ ] Other

List of changes

adds definitions for NIT, TECHDEBT, TECHDEBT(XXX), and SOS keywords for use in code review.

Testing

[ ] make develop_test; if any code changes were made
[ ] make test_e2e on k8s LocalNet; if any code changes were made
[ ] e2e-devnet-test passes tests on DevNet; if any code was changed
[ ] Docker Compose LocalNet; if any major functionality was changed or introduced
[ ] k8s LocalNet; if any infrastructure or configuration changes were made

Required Checklist

[ ] I have performed a self-review of my own code
[ ] I have commented my code, particularly in hard-to-understand areas
[ ] I have added, or updated, godoc format comments on touched members (see: tip.golang.org/doc/comment)
[ ] I have tested my changes using the available tooling
[ ] I have updated the corresponding CHANGELOG

If Applicable Checklist

[ ] I have updated the corresponding README(s); local and/or global
[ ] I have added tests that prove my fix is effective or that my feature works
[ ] I have added, or updated, mermaid.js diagrams in the corresponding README(s)
[ ] I have added, or updated, documentation and mermaid.js diagrams in shared/docs/* if I updated shared/*README(s)