Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions .github/copilot-instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,3 +49,15 @@ Since this is a library build in native go, the files are mostly organized follo
- Document all exported functions, types, and variables with clear and concise comments.
- Use examples in the documentation to illustrate how to use the library effectively.
- Keep documentation up to date with code changes. The package documentation located at `doc.go` should provide an overview of the package and its main functionalities. and the Public documentation at `README.md` should provide an overview of the project, installation instructions, usage examples, and other relevant information.

## Post-Change Checklist

Prefer the Make targets that the repo already defines after making changes:

```bash
make go-fmt # Format code
make go-betteralign # Align struct fields for optimal memory layout
golangci-lint run ./... # Run linter (also checks formatting, vet, and other issues)
make build # Verify build
make test # Run tests
```
4 changes: 2 additions & 2 deletions .github/workflows/pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ permissions:
pull-requests: read

jobs:
build:
test:
runs-on: ubuntu-latest
steps:
- name: Checkout
Expand Down Expand Up @@ -94,7 +94,7 @@ jobs:
run: |
echo "### Test report" >> $GITHUB_STEP_SUMMARY

go test -race -coverprofile=coverage.txt -covermode=atomic -tags=unit ./... | tee -a $GITHUB_STEP_SUMMARY
make test | tee -a $GITHUB_STEP_SUMMARY
echo "" >> $GITHUB_STEP_SUMMARY

- name: Test coverage
Expand Down
Loading
Loading