Skip to content

Commit

Permalink
chore: update pull request template and improve go-checks workflow; e…
Browse files Browse the repository at this point in the history
…nhance 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
  • Loading branch information
publi0 authored Jan 28, 2025
1 parent cad4563 commit 9481feb
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 15 deletions.
13 changes: 0 additions & 13 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -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 -->
2 changes: 1 addition & 1 deletion .github/workflows/go-checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@ go get github.com/MagaluCloud/mgc-sdk-go
- Machine Types
- Images
- Snapshots
- Block Storage
- Volumes
- Snapshots
- Volume Types

## Authentication

Expand All @@ -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
Expand Down

0 comments on commit 9481feb

Please sign in to comment.