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
+76-1Lines changed: 76 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,9 +21,84 @@ Use GitHub Issues page to submit issues, enhancement requests and discuss ideas.
21
21
- Issues that have been identified as a feature request will be labelled `enhancement`.
22
22
23
23
24
-
# Issues
24
+
###Issues
25
25
We use GitHub issues to track public bugs. Please ensure your description is
26
26
clear and has sufficient instructions to be able to reproduce the issue.
27
27
28
28
# Code of Conduct
29
29
Please follow our [Code of Conduct](CODE_OF_CONDUCT.md).
30
+
31
+
# Development
32
+
33
+
## Quick Start
34
+
35
+
### Prerequisites
36
+
37
+
See the [Prerequisites section in README.md](./README.md#prerequisites) for complete setup requirements.
38
+
39
+
### Initial Setup
40
+
41
+
1.**Clone the repository**
42
+
```bash
43
+
git clone <repository-url>
44
+
cd datacloud-customcode-python-sdk
45
+
```
46
+
47
+
2.**Set up virtual environment and install dependencies**
48
+
49
+
**Note**: If you need to set a specific Python version, use `pyenv local 3.11.x` in the project directory.
50
+
51
+
```bash
52
+
python3.11 -m venv .venv
53
+
source .venv/bin/activate
54
+
pip install poetry
55
+
make develop
56
+
```
57
+
58
+
3.**Verify installation**
59
+
```bash
60
+
datacustomcode version
61
+
```
62
+
63
+
4.**Initialize a project for development work verification**
64
+
65
+
**Note**: To test your changes and develop new features, initialize a sample project:
66
+
67
+
```bash
68
+
# Create a new directory for your test project
69
+
mkdir my-test-project
70
+
cd my-test-project
71
+
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
77
+
```
78
+
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
+
## Makefile Commands
82
+
83
+
```bash
84
+
# Clean build artifacts, caches and temporary files
0 commit comments