|
| 1 | +# Contributing to Commerce App Registry |
| 2 | + |
| 3 | +Please follow the guidelines below when submitting new or updated commerce app versions to ensure consistency and smooth reviews. |
| 4 | + |
| 5 | +--- |
| 6 | + |
| 7 | +## Pull Request Requirements |
| 8 | + |
| 9 | +Each PR **must** include the following items: |
| 10 | + |
| 11 | +### 1. Commerce App ZIP File |
| 12 | + |
| 13 | +Include the packaged app as a ZIP file with the following naming convention: |
| 14 | + |
| 15 | +``` |
| 16 | +[appName]-v[appVersion].zip |
| 17 | +``` |
| 18 | + |
| 19 | +**Example:** |
| 20 | +``` |
| 21 | +avalara-tax-v1.0.0.zip |
| 22 | +``` |
| 23 | + |
| 24 | +--- |
| 25 | + |
| 26 | +### 2. `manifest.json` |
| 27 | + |
| 28 | +Each PR must include a `manifest.json` file containing the metadata for the app version. |
| 29 | + |
| 30 | +#### Required Fields |
| 31 | + |
| 32 | +The manifest **must** include the following fields: |
| 33 | + |
| 34 | +- `name` |
| 35 | +- `displayName` |
| 36 | +- `domain` |
| 37 | +- `description` |
| 38 | +- `version` |
| 39 | +- `zip` |
| 40 | +- `sha256` |
| 41 | + |
| 42 | +> **Note:** For new versions of an existing app, you must at minimum update the `version`, `zip`, and `sha256` fields. |
| 43 | +
|
| 44 | +#### Example `manifest.json` |
| 45 | + |
| 46 | +```json |
| 47 | +{ |
| 48 | + "name": "avalara-tax", |
| 49 | + "displayName": "Avalara Tax", |
| 50 | + "domain": "tax", |
| 51 | + "description": "Sample Avalara tax app", |
| 52 | + "version": "1.0.0", |
| 53 | + "zip": "avalara-tax-v1.0.0.zip", |
| 54 | + "sha256": "492fb0bc3aa5c762c0209bd22375e14ed2af8f672b679d6105232a37fe726a4f" |
| 55 | +} |
| 56 | +``` |
| 57 | + |
| 58 | +--- |
| 59 | + |
| 60 | +## Brand New Apps |
| 61 | + |
| 62 | +If you are contributing a **brand new app**, you must also create a `catalog.json` file with **exactly** the following content so CI can update it: |
| 63 | + |
| 64 | +```json |
| 65 | +{ |
| 66 | + "latest": { |
| 67 | + "version": "INIT", |
| 68 | + "tag": "INIT" |
| 69 | + }, |
| 70 | + "versions": [] |
| 71 | +} |
| 72 | +``` |
| 73 | + |
| 74 | +--- |
| 75 | + |
| 76 | +## Final Checklist |
| 77 | + |
| 78 | +Before submitting your PR, please verify: |
| 79 | + |
| 80 | +- [ ] ZIP file name follows the required format |
| 81 | +- [ ] `manifest.json` includes all required fields |
| 82 | +- [ ] `version`, `zip`, and `sha256` are updated correctly |
| 83 | +- [ ] `catalog.json` is included for new apps only |
| 84 | + |
| 85 | + |
0 commit comments