Skip to content

Commit 4f3bebe

Browse files
authored
Adding my own instructions for agents (#5147)
NO_CHANGELOG=true ## Changes <!-- Summary of your changes that are easy to understand --> ## Tests <!-- How is this tested? Please see the checklist below and also describe any other relevant tests --> - [ ] `make test` run locally - [ ] relevant change in `docs/` folder - [ ] covered with integration tests in `internal/acceptance` - [ ] using Go SDK - [ ] using TF Plugin Framework - [ ] has entry in `NEXT_CHANGELOG.md` file
1 parent f70a164 commit 4f3bebe

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

AGENTS.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,10 +120,16 @@ Some Unity Catalog resources (e.g., storage credentials, external locations) wor
120120

121121
### Code Organization
122122
- Files should not exceed 600 lines
123+
- don't make changes in files that have `DO NOT EDIT` in the first line
123124
- Functions should fit on a 13" screen (max 40 lines, except tests)
124125
- No unnecessary package exports (avoid public structs/types unless needed outside package)
125126
- Use `qa.EnvironmentTemplate()` instead of complex `fmt.Sprintf` with >4 placeholders
126127

128+
### Writing unit tests for resources and data sources
129+
130+
For unit tests use the `MockWorkspaceClientFunc` from Databricks Go SDK instead of `HTTPFixture`.
131+
Use `ApplyAndExpectData` where it's possible.
132+
127133
### Import Conventions
128134
Order imports as: Go standard library, vendor packages, current provider packages.
129135
Within each section, maintain alphabetical order.
@@ -145,4 +151,4 @@ All user-facing changes must be documented in `NEXT_CHANGELOG.md` with format:
145151
### Migration Verification
146152
When migrating resources to Plugin Framework, always run `make diff-schema` to ensure no breaking changes to the Terraform schema.
147153

148-
- Always run make fmt before making any commit.
154+
- Always run `make fmt lint ws` before making any commit.

0 commit comments

Comments
 (0)