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
+1-15Lines changed: 1 addition & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -61,11 +61,9 @@ Share your use cases! Example notebooks and tutorials help others understand how
61
61
Help us improve test coverage by adding tests for untested code paths or edge cases.
62
62
63
63
## Feature Requests
64
-
65
64
Data Designer is designed to be as flexible and extensible as possible, and we welcome your ideas for pushing its capabilities even further! To keep the core library maintainable, while also supporting innovation, we take an incremental approach: we explore what's already possible, extend through plugins when needed, and integrate the most broadly useful features into the core library:
66
65
67
66
### How We Grow Data Designer
68
-
69
67
1. 🧗 **Explore what's possible**: Can your use case be achieved with current features? We've designed Data Designer to be composable – sometimes creative combinations of existing tools can accomplish what you need. Check out our examples or open an issue if you'd like help exploring this!
70
68
71
69
2. 🔌 **Extend through plugins**: If existing features aren't quite enough, consider implementing your idea as a plugin that extends the core library. Plugins let you experiment and share innovations while keeping the core focused.
@@ -75,7 +73,6 @@ Data Designer is designed to be as flexible and extensible as possible, and we w
75
73
This approach helps us grow thoughtfully while keeping Data Designer reliable for everyone.
76
74
77
75
### Submitting a Feature Request
78
-
79
76
Open a [new issue](https://github.com/NVIDIA-NeMo/DataDesigner/issues/new) with:
80
77
81
78
-**Clear title**: Concise description of the feature
@@ -86,11 +83,9 @@ Open a [new issue](https://github.com/NVIDIA-NeMo/DataDesigner/issues/new) with:
86
83
-**Willingness to implement**: Are you interested in implementing this yourself?
87
84
88
85
## Development Guide
89
-
90
86
Data Designer uses [`uv`](https://github.com/astral-sh/uv) for dependency management. If you don't have uv installed, follow their [installation instructions](https://docs.astral.sh/uv/getting-started/installation/).
91
87
92
88
### Initial Setup
93
-
94
89
0.**Create or find an issue**
95
90
96
91
Before starting work, ensure there's an issue tracking your contribution:
@@ -120,12 +115,6 @@ Data Designer uses [`uv`](https://github.com/astral-sh/uv) for dependency manage
120
115
make install-dev-notebooks
121
116
```
122
117
123
-
This creates a virtual environment in `.venv`. Activate it with:
124
-
125
-
```bash
126
-
source .venv/bin/activate
127
-
```
128
-
129
118
3.**Verify your setup**
130
119
131
120
```bash
@@ -223,13 +212,11 @@ Ensure your changes meet the following criteria:
223
212
- Your contribution will be included in the next release!
224
213
225
214
## Code of Conduct
226
-
227
215
Data Designer follows the Contributor Covenant Code of Conduct. We are committed to providing a welcoming and inclusive environment for all contributors.
228
216
229
217
**Please read our complete [Code of Conduct](CODE_OF_CONDUCT.md)** for full details on our standards and expectations.
230
218
231
-
### Copyright
232
-
219
+
### License File Headers
233
220
All code files that are added to this repository must include the appropriate NVIDIA copyright header:
234
221
235
222
```python
@@ -240,7 +227,6 @@ All code files that are added to this repository must include the appropriate NV
240
227
Use `make update-license-headers` to add headers automatically.
241
228
242
229
## Getting Help
243
-
244
230
Need help with your contribution?
245
231
246
232
-**Documentation**: Check the [documentation](docs/) and [AGENTS.md](AGENTS.md) for additional information
0 commit comments