Skip to content

Commit c933641

Browse files
Improve CONTRIBUTING guidelines (#23)
Signed-off-by: alessiodevoto <adevoto@nvidia.com>
1 parent a6a7ba5 commit c933641

1 file changed

Lines changed: 32 additions & 1 deletion

File tree

CONTRIBUTING.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,37 @@ A few light conventions:
2626

2727
For CLI output: `print` is for the main thing a user (or follow-up command) is going to read, `console.print` is for Rich tables and formatted output, and `logging` is for diagnostics that aren't part of the command's data output.
2828

29+
Start each change from a focused branch with a short owner prefix:
30+
31+
```bash
32+
git checkout -b <owner>/<short-change-name>
33+
```
34+
35+
### Developer Certificate of Origin
36+
37+
All commits must include a DCO sign-off. The easiest way to do that is to commit with `-s`:
38+
39+
```bash
40+
git commit -s -m "Describe the change"
41+
```
42+
43+
If you already made a commit and need to add the sign-off, amend it before opening the PR:
44+
45+
```bash
46+
git commit --amend -s --no-edit
47+
```
48+
49+
### License Headers
50+
51+
New non-markdown code files need SPDX license headers. For Python files, add this at the top of the file after any shebang:
52+
53+
```python
54+
# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
55+
# SPDX-License-Identifier: MIT
56+
```
57+
58+
For other code file types, use the file's native comment syntax and include both `SPDX-FileCopyrightText` and `SPDX-License-Identifier`. Documentation and markdown files do not need SPDX headers.
59+
2960
## Credentials
3061

3162
Please don't commit `.env`, `kaggle.json`, generated private notebooks, or other account artifacts. Skills should read credentials from `KAGGLE_API_TOKEN` (or another environment variable), not from a file checked into the repo.
@@ -60,4 +91,4 @@ Manual Claude Agent SDK smoke tests live under `tests/actions/<capability>/` —
6091

6192
## Submitting Changes
6293

63-
Branches use a short owner prefix (e.g. `ad/readme-clarify`). When you're ready, open a PR and keep the description focused on *why* the change is needed — the diff already covers *what*.
94+
Branches use a short owner prefix (e.g. `ad/readme-clarify`). When you're ready, open a PR and keep the description focused on *why* the change is needed — the diff already covers *what*. Confirm that tests pass, every commit is signed off, and new code files include the required SPDX headers before requesting review.

0 commit comments

Comments
 (0)