Skip to content

Commit 7b81407

Browse files
committed
[ci skip] Update links in CONTRIBUTING.md
1 parent 413d057 commit 7b81407

1 file changed

Lines changed: 18 additions & 18 deletions

File tree

CONTRIBUTING.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
If you are interested in contributing to cuTile, your contributions will fall
88
into three categories:
99
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)
1111
describing what you encountered or what you want to see changed.
1212
- The cuTile team will evaluate the issues and triage them, scheduling
1313
them for a release. If you believe the issue needs priority attention
@@ -24,32 +24,34 @@ into three categories:
2424

2525
## Code contributions
2626

27+
Code contribution is currently not open until we establish our Github CI. Please stay tuned.
28+
2729
### Your first issue
2830

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)
3032
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
3335
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.
4241

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!
4443

4544
### Managing PR labels
4645

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.
4849

4950
For cuTile, a "breaking" change is one that modifies the public, non-experimental, Python API in a
5051
non-backward-compatible way.
5152

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.
5355

5456
### Seasoned developers
5557

@@ -66,11 +68,9 @@ implementation of the issue, ask them in the issue instead of the PR.
6668

6769
### Branches and Versions
6870

69-
TBD
70-
7171
### Branch naming
7272

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>`
7474
which conforms to the following conventions:
7575
- Type:
7676
- fea - For if the branch is for a new feature(s)

0 commit comments

Comments
 (0)