Skip to content

Commit 42d2ed9

Browse files
authored
Change how package names should be chosen. (GoogleCloudPlatform#2637)
Memorialize our conversation about package names today.
1 parent a9b2f58 commit 42d2ed9

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

SAMPLE_FORMAT.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -282,10 +282,12 @@ The `-DskipTests` is optional. It is useful if you want to verify that your code
282282
builds and adheres to the style guide without waiting for tests to complete.
283283

284284
### Package Names
285-
Samples should use package names in the following formats:
286-
`com.example.<YOUR_PRODUCT>.<FOLDER>`, such as `com.example.dlp.snippets` or
287-
`com.example.functions.snippets`. NEVER use `com.google.*` for samples or snippets. Use of the
288-
default package is discouraged.
285+
Samples should use package names in the following formats:
286+
287+
`<PRODUCT>`, `<PRODUCT1>.<PRODUCT2>`, `<PRODUCT>.<IDEA>` is preferred, fewer levels is prefered.
288+
Legacy samples that use `com.example.<YOUR_PRODUCT>.<FOLDER>`, such as `com.example.dlp.snippets` or
289+
`com.example.functions.snippets` are still accepted and do not need to migrate to the perfered system (above).
290+
**NEVER** use `com.google.*` for samples or snippets. Use of the default package is **strongly** discouraged.
289291

290292
### Class Structure
291293
Each snippet should be be contained in its own file, within a class with a name descriptive of the

0 commit comments

Comments
 (0)