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
+28-9Lines changed: 28 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -60,24 +60,43 @@ See the [Prerequisites section in README.md](./README.md#prerequisites) for comp
60
60
datacustomcode version
61
61
```
62
62
63
-
4.**Initialize a project for development work verification**
63
+
4.**Install the SF CLI and plugin**
64
64
65
-
**Note**: To test your changes and develop new features, initialize a sample project:
65
+
The SF CLI is how you test your SDK changes end-to-end (`init`, `scan`, `zip`, `run`, `deploy`).
66
+
67
+
```bash
68
+
# Install the Salesforce CLI (requires Node.js)
69
+
npm install -g @salesforce/cli
70
+
71
+
# Install the Data Cloud Code Extension plugin
72
+
sf plugins install @salesforce/plugin-data-code-extension
73
+
```
74
+
75
+
5.**Build and install your local SDK changes**
76
+
77
+
The SF CLI plugin resolves templates from the installed package path. After making changes, build a wheel and install it:
78
+
79
+
```bash
80
+
poetry build
81
+
$(poetry env info --path)/bin/pip install dist/*.whl --force-reinstall --no-deps
82
+
```
83
+
84
+
Re-run these two commands each time you make SDK changes you want to test via the SF CLI.
85
+
86
+
6.**Test your changes**
66
87
67
88
```bash
68
89
# Create a new directory for your test project
69
90
mkdir my-test-project
70
91
cd my-test-project
71
92
72
-
# Initialize a new Data Cloud custom code project
73
-
datacustomcode init .
74
-
75
-
# Test your SDK modifications against the sample project with:
76
-
datacustomcode run ./payload/entrypoint.py
93
+
# Initialize, scan, zip, run
94
+
sf data-code-extension script init --package-dir.
95
+
sf data-code-extension script scan --entrypoint payload/entrypoint.py
96
+
sf data-code-extension script zip --package-dir .
97
+
sf data-code-extension script run --entrypoint payload/entrypoint.py -o <your-org-alias>
77
98
```
78
99
79
-
**Tip**: See the [README.md](./README.md) for additional `datacustomcode` commands (`scan`, `deploy`, `zip`) to test specific code paths and validate your SDK changes thoroughly.
80
-
81
100
## Versioning and Pre-Releases
82
101
83
102
This project uses [PEP 440](https://peps.python.org/pep-0440/) version syntax. Versions are derived automatically from git tags via `poetry-dynamic-versioning`.
0 commit comments