From 9481febf9f578d9ccef8b72319a0645491c2a823 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Felipe=20Canton=20P=C3=BAblio?= <felipe@publio.dev>
Date: Tue, 28 Jan 2025 14:18:25 -0300
Subject: [PATCH] chore: update pull request template and improve go-checks
 workflow; enhance README with Block Storage details (#25)

* chore: update pull request template and improve go-checks workflow; enhance README with Block Storage details

* fix: correct backtick in gofmt issue comment in workflow
---
 .github/pull_request_template.md | 13 -------------
 .github/workflows/go-checks.yml  |  2 +-
 README.md                        |  6 +++++-
 3 files changed, 6 insertions(+), 15 deletions(-)

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index c75e2c3..271ea02 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,23 +1,10 @@
 ## What does this PR do?
 <!-- Provide a clear and concise description of the changes -->
-<!--Example: This PR adds a new endpoint to the API that allows users to retrieve their order history. It includes the necessary changes to the controller, service, and repository layers, as well as updates to the API documentation. -->
 
 ## How Has This Been Tested?
 <!-- Please describe the tests you ran to verify your changes and how you tested them. Include any relevant details and evidence. -->
-- **Unit Tests**: Describe the unit tests you have written and their outcomes.
-  <!-- Example: Added unit tests for the new order history endpoint. All tests passed successfully. -->
-
-- **Integration Tests**: Detail the integration tests performed and their results.
-  <!-- Example: Performed integration tests with the payment service to ensure end-to-end functionality. All tests passed. -->
-
-- **Manual Testing**: Explain the manual testing process, including steps taken and evidence such as screenshots or logs.
-  <!-- Example: Manually tested the new endpoint using Postman. Verified that the correct order history is returned for different users. Attached screenshots of the Postman results. -->
 
 ## Checklist
-- [ ] I have run Pre commit `pre-commit run --all-files`
 - [ ] My code follows the style guidelines of this project
 - [ ] I have made corresponding changes to the documentation
 - [ ] I have added tests that prove my fix is effective or that my feature works
-
-## Screenshots/Videos
-<!-- If applicable, add screenshots or videos to help explain your changes -->
\ No newline at end of file
diff --git a/.github/workflows/go-checks.yml b/.github/workflows/go-checks.yml
index c7522f5..75e388c 100644
--- a/.github/workflows/go-checks.yml
+++ b/.github/workflows/go-checks.yml
@@ -65,7 +65,7 @@ jobs:
 
             // Add gofmt errors if present
             if (process.env.FMT_ERRORS) {
-              commentBody += `### 🛠️ gofmt Issues\n\nThe following files are not formatted:\n\`\`\`\n${process.env.FMT_ERRORS}\n\`\`\`\nRun \`gofmt -w .\` to fix.\n\n`;
+              commentBody += `### 🛠️ gofmt Issues\n\nThe following files are not formatted:\n\`\`\`\n${process.env.FMT_ERRORS}\n\`\`\`\nRun \`make go-fmt\` to fix.\n\n`;
             }
 
             // Add govet errors if present
diff --git a/README.md b/README.md
index e197ef5..8263ec0 100644
--- a/README.md
+++ b/README.md
@@ -30,6 +30,10 @@ go get github.com/MagaluCloud/mgc-sdk-go
   - Machine Types
   - Images
   - Snapshots
+- Block Storage
+  - Volumes
+  - Snapshots
+  - Volume Types
 
 ## Authentication
 
@@ -49,7 +53,7 @@ mgc-sdk-go/
 ├── compute/        # Compute service API (instances, images, machine types)
 ├── helpers/        # Utility functions
 ├── internal/       # Internal packages
-└── cmd/           # Command-line examples
+└── cmd/            # Examples
 ```
 
 ## Usage Examples