Merge pull request #291 from libdns/pr/linter-and-cleanup-202509271110

Add: golangci-lint and related code cleanup

Author: AndrianBdn

.github/workflows/build.yml

@@ -20,6 +20,12 @@ jobs:
         with:
           go-version: 'stable'
 
+
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v8
+        with:
+          version: v2.5
+
       - name: Build
         run: go build -v ./...
 

.golangci.yml

@@ -5,6 +5,42 @@ Route53 for `libdns`
 
 This package implements the [libdns interfaces](https://github.com/libdns/libdns) for AWS [Route53](https://aws.amazon.com/route53/).
 
+## Example
+
+```go
+package main
+
+import (
+	"context"
+	"fmt"
+	"time"
+
+	"github.com/libdns/route53"
+)
+
+func main() {
+	// greate a new Route53 provider instance
+	provider := &route53.Provider{
+		AccessKeyId:     "YOUR_ACCESS_KEY_ID",
+		SecretAccessKey: "YOUR_SECRET_ACCESS_KEY",
+		Region:          "us-east-1",
+	}
+
+	ctx := context.Background()
+	zone := "example.com."
+
+	// get all records for the zone
+	records, err := provider.GetRecords(ctx, zone)
+	if err != nil {
+		panic(err)
+	}
+
+	for _, record := range records {
+		fmt.Printf("%s %s %s %d\n", record.Name, record.Type, record.Value, record.TTL/time.Second)
+	}
+}
+```
+
 ## Authenticating
 
 This package supports all the credential configuration methods described in the [AWS Developer Guide](https://aws.github.io/aws-sdk-go-v2/docs/configuring-sdk/#specifying-credentials), such as `Environment Variables`, `Shared configuration files`, the `AWS Credentials file` located in `.aws/credentials`, and `Static Credentials`. You may also pass in static credentials directly (or via caddy's configuration).
@@ -40,3 +76,27 @@ The following IAM policy is a minimal working example to give `libdns` permissio
     ]
 }
 ```
+
+## Contributing
+
+Contributions are welcome! Please ensure that:
+
+1. All code passes `golangci-lint` checks. Run the following before committing:
+   ```bash
+   golangci-lint run ./...
+   ```
+
+2. All tests pass:
+   ```bash
+   go test ./...
+   ```
+
+3. For integration tests, set up the required environment variables:
+   ```bash
+   export AWS_ACCESS_KEY_ID="your-key"
+   export AWS_SECRET_ACCESS_KEY="your-secret"
+   export ROUTE53_TEST_ZONE="test.example.com."
+   cd libdnstest && go test -v
+   ```
+
+Please fix any linter issues before submitting a pull request. The project maintains strict code quality standards to ensure maintainability.