Closed titpetric closed 1 month ago
API Changes
--- prev.txt 2024-07-11 08:14:58.687084906 +0000
+++ current.txt 2024-07-11 08:14:55.723086439 +0000
@@ -12051,6 +12051,8 @@
func MyPluginReturningError(rw http.ResponseWriter, r *http.Request)
# Package: ./tests/regression
+package regression // import "github.com/TykTechnologies/tyk/tests/regression"
+
# Package: ./trace
package trace // import "github.com/TykTechnologies/tyk/trace"
โฑ๏ธ Estimated effort to review: 1 ๐ตโชโชโชโช |
๐งช No relevant tests |
๐ No security concerns identified |
โก No key issues to review |
Category | Suggestion | Score |
Best practice |
Add a descriptive package declaration comment___ **It is recommended to include a package declaration comment directly above thepackage statement to clarify the purpose of the package. This is especially useful in a test directory where the purpose might not be immediately clear.** [tests/regression/regression.go [1]](https://github.com/TykTechnologies/tyk/pull/6400/files#diff-4b98736bd1eadf9ac1c9735ef633fc19b5b9df2a41d503a1ab2b6ef255125e0bR1-R1) ```diff +// Package regression provides utilities to handle API regression tests. package regression ``` Suggestion importance[1-10]: 8Why: Adding a descriptive package declaration comment improves code readability and maintainability by clarifying the purpose of the package, which is especially useful in a test directory. | 8 |
Issues
0 New issues
0 Accepted issues
Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code
https://tyktech.atlassian.net/browse/TT-12575
Description
regression
to support go doc change reporting.Changes walkthrough ๐
regression.go
Add new Go package for regression tests
tests/regression/regression.go
regression
.doc change reporting.