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
+18-18Lines changed: 18 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@
7
7
If you are interested in contributing to cuTile, your contributions will fall
8
8
into three categories:
9
9
1. You want to report a bug, feature request, or documentation issue
10
-
- File an [issue](https://github.com/nvidia/cutile/issues/new/choose)
10
+
- File an [issue](https://github.com/nvidia/cutile-python/issues/new/choose)
11
11
describing what you encountered or what you want to see changed.
12
12
- The cuTile team will evaluate the issues and triage them, scheduling
13
13
them for a release. If you believe the issue needs priority attention
@@ -24,32 +24,34 @@ into three categories:
24
24
25
25
## Code contributions
26
26
27
+
Code contribution is currently not open until we establish our Github CI. Please stay tuned.
28
+
27
29
### Your first issue
28
30
29
-
1. Read the project's [README.md](https://github.com/nvidia/cutile/blob/main/README.md)
31
+
1. Read the project's [README.md](https://github.com/nvidia/cutile-python/blob/main/README.md)
30
32
to learn how to setup the development environment.
31
-
2. Find an issue to work on. The best way is to look for the [good first issue](https://github.com/nvidia/cutile/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
32
-
or [help wanted](https://github.com/nvidia/cutile/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) labels
33
+
2. Find an issue to work on. The best way is to look for the [good first issue](https://github.com/nvidia/cutile-python/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
34
+
or [help wanted](https://github.com/nvidia/cutile-python/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) labels
33
35
3. Comment on the issue saying you are going to work on it.
34
-
4. Get familar with the developer guide relevant for you:
35
-
* For C++ developers it is available here TBD
36
-
* For Python developers, it is available here TBD
37
-
5. Code! Make sure to update unit tests!
38
-
6. When done, [create your pull request](https://github.com/nvidia/cutile/compare).
39
-
7. Verify that CI passes all [status checks](https://help.github.com/articles/about-status-checks/), or fix if needed.
40
-
8. Wait for other developers to review your code and update code as needed.
41
-
9. Once reviewed and approved, a cuTile developer will merge your pull request.
36
+
4. Code! Make sure to update unit tests!
37
+
5. When done, [create your pull request](https://github.com/nvidia/cutile-python/compare).
38
+
6. Verify that CI passes all [status checks](https://help.github.com/articles/about-status-checks/), or fix if needed.
39
+
7. Wait for other developers to review your code and update code as needed.
40
+
8. Once reviewed and approved, a cuTile developer will merge your pull request.
42
41
43
-
Remember, if you are unsure about anything, don't hesitate to comment on issues and ask for clarifications!
42
+
If you are unsure about anything, don't hesitate to comment on issues and ask for clarifications!
44
43
45
44
### Managing PR labels
46
45
47
-
Each PR must be labeled according to whether it is a "breaking" or "non-breaking" change (using Github labels). This is used to highlight changes that users should know about when upgrading.
46
+
Each PR must be labeled according to whether it is a "breaking" or
47
+
"non-breaking" change (using Github labels). This is used to highlight changes
48
+
that users should know about when upgrading.
48
49
49
50
For cuTile, a "breaking" change is one that modifies the public, non-experimental, Python API in a
50
51
non-backward-compatible way.
51
52
52
-
Additional labels must be applied to indicate whether the change is a feature, improvement, bugfix, or documentation change.
53
+
Additional labels must be applied to indicate whether the change is a feature,
54
+
improvement, bugfix, or documentation change.
53
55
54
56
### Seasoned developers
55
57
@@ -66,11 +68,9 @@ implementation of the issue, ask them in the issue instead of the PR.
66
68
67
69
### Branches and Versions
68
70
69
-
TBD
70
-
71
71
### Branch naming
72
72
73
-
Branches used to create PRs should have a name of the form `<type>-<name>`
73
+
Branches used to create PRs should have a name of the form `<username>/<type>-<name>`
0 commit comments