-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: Add Contributing Guidelines #463
docs: Add Contributing Guidelines #463
Conversation
Codecov Report
@@ Coverage Diff @@
## master #463 +/- ##
=======================================
Coverage 97.05% 97.05%
=======================================
Files 17 17
Lines 714 714
=======================================
Hits 693 693
Misses 15 15
Partials 6 6 |
@sashabaranov I've written the Contributing Guidelines. Please check them. If there are any rules you'd like to add, remove, or update, please let me know. |
@sashabaranov It looks like you're busy, so I'll go ahead and merge this for now. If there are any issues or feedback regarding this guideline, I'll respond right away. |
Oh, I see. I can't approve a pull request that I created myself. |
``` | ||
|
||
``` | ||
goimports -w . |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a really great PR, thank you so much @vvatanabe! Sorry for such a long delay with the review.
Just a note: it seems that golangci-lint does include goimports into itself, so it's enough to run to just run the golangci-lint.
To reproduce:
diff --git a/completion_test.go b/completion_test.go
index 844ef48..3a63504 100644
--- a/completion_test.go
+++ b/completion_test.go
@@ -4,6 +4,7 @@ import (
. "github.com/sashabaranov/go-openai"
"github.com/sashabaranov/go-openai/internal/test/checks"
+ "testing"
"context"
"encoding/json"
"errors"
@@ -12,7 +13,6 @@ import (
"net/http"
"strconv"
"strings"
- "testing"
"time"
)
Produces:
% golangci-lint run ./...
completion_test.go:7: File is not `goimports`-ed (goimports)
"testing"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@sashabaranov Thanks for the feedback. Indeed, golangci-lint
does give warnings, but to fix them, you need to run goimports yourself. I've added instructions on how to run goimports
to help developers who are not familiar with Go handle it smoothly.
Don't worry about the delayed response. You should focus on what you need to prioritize! It's more important.
Describe the change
Tests
None
Additional context
None