You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+39Lines changed: 39 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,6 +21,45 @@ Include the packaged app as a ZIP file with the following naming convention:
21
21
avalara-tax-v1.0.0.zip
22
22
```
23
23
24
+
#### How to Generate the ZIP File
25
+
26
+
When creating your ZIP file, it's important to exclude system files and hidden files that shouldn't be included in the archive. Use the following commands based on your operating system:
27
+
28
+
##### macOS & Linux (Terminal)
29
+
30
+
Both macOS and Linux use the `zip` utility. The `-x` flag is your best friend here—it tells the utility to exclude specific patterns.
-`-r`: Stands for "recursive." It tells the computer to look inside every subfolder.
39
+
-`"*.DS_Store"`: Excludes the macOS folder settings file.
40
+
-`"__MACOSX/*"`: Prevents the creation of those annoying resource fork folders.
41
+
-`"*/.*"`: The "nuclear option"—this excludes all hidden files (anything starting with a dot).
42
+
-`"Thumbs.db"`: Excludes the Windows thumbnail cache.
43
+
44
+
##### Windows (PowerShell)
45
+
46
+
Windows doesn't have a native "exclude" flag built into its basic `Compress-Archive` command. To do this cleanly without third-party software, you have to filter the files first and then pipe them into the zip command.
-`Get-ChildItem`: Grabs every file in your folder.
60
+
-`Where-Object`: This acts as a filter. We tell it to only keep files that do not match our "junk" patterns (no .DS_Store, no __MACOSX, no files starting with a dot, and no Thumbs.db).
61
+
-`Compress-Archive`: Takes that filtered list and zips it up.
0 commit comments