Skip to content

Commit 5c56f96

Browse files
aflataflat
authored
Initial commit
0 parents  commit 5c56f96

23 files changed

+1359
-0
lines changed

‎.github/CODEOWNERS‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
#cpp code owners
2+
cpp/ @<org>/<repo>-cpp-codeowners
3+
4+
#python code owners
5+
python/ @<org>/<repo>-python-codeowners
6+
7+
#cmake code owners
8+
**/CMakeLists.txt @<org>/<repo>-cmake-codeowners
9+
**/cmake/ @<org>/<repo>-cmake-codeowners
10+
11+
#build/ops code owners
12+
.github/ @<org>/ops-codeowners
13+
ci/ @<org>/ops-codeowners
14+
conda/ @<org>/ops-codeowners
15+
**/Dockerfile @<org>/ops-codeowners
16+
**/.dockerignore @<org>/ops-codeowners
17+
docker/ @<org>/ops-codeowners

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: Bug report
3+
about: Create a bug report to help us improve ___PROJECT___
4+
title: "[BUG]"
5+
labels: "? - Needs Triage, bug"
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**Steps/Code to reproduce bug**
14+
Follow [this guide](http://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) to craft a minimal bug report. This helps us reproduce the issue you're having and resolve the issue more quickly.
15+
16+
**Expected behavior**
17+
A clear and concise description of what you expected to happen.
18+
19+
**Environment details (please complete the following information):**
20+
- Environment location: [Bare-metal, Docker, Cloud(specify cloud provider)]
21+
- Method of ___PROJECT___ install: [conda, Docker, pip, or from source]
22+
- If method of install is [Docker], provide `docker pull` & `docker run` commands used
23+
- Run `print_env.sh` from the project root and paste the results here
24+
25+
26+
**Additional context**
27+
Add any other context about the problem here.
28+
29+
-----
30+
By submitting this issue, you agree to follow our [code of conduct](https://docs.rapids.ai/resources/conduct/) and our [contributing guidelines](https://github.com/jarmak-nv/rapids-repo-template/blob/main/CONTRIBUTING.md).

‎.github/ISSUE_TEMPLATE/bug_report_form.yml‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
# SPDX-FileCopyrightText: Copyright (c) 2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
2+
# SPDX-License-Identifier: Apache-2.0
3+
#
4+
# Licensed under the Apache License, Version 2.0 (the "License");
5+
# you may not use this file except in compliance with the License.
6+
# You may obtain a copy of the License at
7+
#
8+
# http://www.apache.org/licenses/LICENSE-2.0
9+
#
10+
# Unless required by applicable law or agreed to in writing, software
11+
# distributed under the License is distributed on an "AS IS" BASIS,
12+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
# See the License for the specific language governing permissions and
14+
# limitations under the License.
15+
16+
name: Bug Report
17+
description: File a bug report
18+
title: "[BUG]: "
19+
labels: ["bug"]
20+
21+
body:
22+
- type: markdown
23+
attributes:
24+
value: |
25+
Thanks for taking the time to fill out this bug report!
26+
27+
- type: input
28+
id: version
29+
attributes:
30+
label: Version
31+
description: What version of __PROJECT__ are you running?
32+
placeholder: "example: 23.02"
33+
validations:
34+
required: true
35+
36+
- type: dropdown
37+
id: installation-method
38+
attributes:
39+
label: Which installation method(s) does this occur on?
40+
multiple: true
41+
options:
42+
- Docker
43+
- Conda
44+
- Pip
45+
- Source
46+
47+
- type: textarea
48+
id: description
49+
attributes:
50+
label: Describe the bug.
51+
description: Also tell us, what did you expect to happen?
52+
placeholder: XYZ occured, I expected QRS results
53+
validations:
54+
required: true
55+
56+
- type: textarea
57+
id: mvr
58+
attributes:
59+
label: Minimum reproducible example
60+
description: Please supply a [minimum reproducible code example](https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) here
61+
render: shell
62+
63+
- type: textarea
64+
id: logs
65+
attributes:
66+
label: Relevant log output
67+
description: Please paste relevant error and log output here
68+
render: shell
69+
70+
- type: textarea
71+
id: env-printout
72+
attributes:
73+
label: Full env printout
74+
description: Please run and paste the output of the `print_env.sh` script here, to gather any other relevant environment details
75+
render: shell
76+
77+
- type: textarea
78+
id: misc
79+
attributes:
80+
label: Other/Misc.
81+
description: Please enter any other helpful information here.
82+
83+
- type: checkboxes
84+
id: terms
85+
attributes:
86+
label: Code of Conduct
87+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://docs.rapids.ai/resources/conduct/)
88+
options:
89+
- label: I agree to follow __THIS PROJECT__'s Code of Conduct
90+
required: true
91+
- label: I have searched the [open bugs](https://github.com/jarmak-nv/issues?q=is%3Aopen+is%3Aissue+label%3Abug) and have found no duplicates for this bug report
92+
required: true

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# GitHub info on config.yml
2+
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
3+
# Set to 'false' if you only want the templates to be used.
4+
blank_issues_enabled: true
5+
6+
# When using discussions instead of Question issue templates,
7+
# link that below to have it show up in the 'Submit Issue' page
8+
contact_links:
9+
- name: Ask a Question
10+
url: https://github.com/jarmak-nv/rapids-repo-template/discussions
11+
about: Please ask any questions here.

‎.github/ISSUE_TEMPLATE/documentation-request.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
name: Documentation request
3+
about: Report incorrect or needed documentation
4+
title: "[DOC]"
5+
labels: "? - Needs Triage, doc"
6+
assignees: ''
7+
8+
---
9+
10+
11+
<!-- Fill out either incorrect documentation, or needed documentation and delete the unused section -->
12+
13+
## Report incorrect documentation
14+
15+
**Location of incorrect documentation**
16+
Provide links and line numbers if applicable.
17+
18+
**Describe the problems or issues found in the documentation**
19+
A clear and concise description of what you found to be incorrect.
20+
21+
**Steps taken to verify documentation is incorrect**
22+
List any steps you have taken:
23+
24+
**Suggested fix for documentation**
25+
Detail proposed changes to fix the documentation if you have any.
26+
27+
---
28+
29+
## Report needed documentation
30+
31+
**Report needed documentation**
32+
A clear and concise description of what documentation you believe it is needed and why.
33+
34+
**Describe the documentation you'd like**
35+
A clear and concise description of what you want to happen.
36+
37+
**Steps taken to search for needed documentation**
38+
List any steps you have taken:
39+
40+
41+
-----
42+
By submitting this issue, you agree to follow our [code of conduct](https://docs.rapids.ai/resources/conduct/) and our [contributing guidelines](https://github.com/jarmak-nv/rapids-repo-template/blob/main/CONTRIBUTING.md).

‎.github/ISSUE_TEMPLATE/documentation_request_correction.yml‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# SPDX-FileCopyrightText: Copyright (c) 2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
2+
# SPDX-License-Identifier: Apache-2.0
3+
#
4+
# Licensed under the Apache License, Version 2.0 (the "License");
5+
# you may not use this file except in compliance with the License.
6+
# You may obtain a copy of the License at
7+
#
8+
# http://www.apache.org/licenses/LICENSE-2.0
9+
#
10+
# Unless required by applicable law or agreed to in writing, software
11+
# distributed under the License is distributed on an "AS IS" BASIS,
12+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
# See the License for the specific language governing permissions and
14+
# limitations under the License.
15+
16+
name: Documentation - Correction/Update Request
17+
description: Request corrections or updates to existing documentation
18+
title: "[DOC]: "
19+
labels: ["doc"]
20+
21+
body:
22+
- type: markdown
23+
attributes:
24+
value: |
25+
Thanks for taking the time to improve our documentation!
26+
27+
- type: dropdown
28+
id: criticality
29+
attributes:
30+
label: How would you describe the priority of this documentation request
31+
options:
32+
- Critical (currently preventing usage)
33+
- High
34+
- Medium
35+
- Low (would be nice)
36+
validations:
37+
required: true
38+
39+
- type: input
40+
id: correction_location
41+
attributes:
42+
label: Please provide a link or source to the relevant docs
43+
placeholder: "ex: https://github.com/jarmak-nv/rapids-repo-template/blob/main/README.md"
44+
validations:
45+
required: true
46+
47+
- type: textarea
48+
id: problem
49+
attributes:
50+
label: Describe the problems in the documentation
51+
placeholder: The documents say to use foo.func(args) however an AttributeError is thrown
52+
validations:
53+
required: true
54+
55+
- type: textarea
56+
id: correction
57+
attributes:
58+
label: (Optional) Propose a correction
59+
placeholder: foo.func() was deprecated, replace documentation with foo.new_func()
60+
61+
- type: checkboxes
62+
id: terms
63+
attributes:
64+
label: Code of Conduct
65+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/jarmak-nv/rapids-repo-template/blob/main/CODE_OF_CONDUCT.md)
66+
options:
67+
- label: I agree to follow __PROJECT__'s Code of Conduct
68+
required: true
69+
- label: I have searched the [open documentation issues](https://github.com/jarmak-nv/rapids-repo-template/issues?q=is%3Aopen+is%3Aissue+label%3Adoc) and have found no duplicates for this bug report
70+
required: true

‎.github/ISSUE_TEMPLATE/documentation_request_new.yml‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# SPDX-FileCopyrightText: Copyright (c) 2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
2+
# SPDX-License-Identifier: Apache-2.0
3+
#
4+
# Licensed under the Apache License, Version 2.0 (the "License");
5+
# you may not use this file except in compliance with the License.
6+
# You may obtain a copy of the License at
7+
#
8+
# http://www.apache.org/licenses/LICENSE-2.0
9+
#
10+
# Unless required by applicable law or agreed to in writing, software
11+
# distributed under the License is distributed on an "AS IS" BASIS,
12+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
# See the License for the specific language governing permissions and
14+
# limitations under the License.
15+
16+
name: Documentation - New Documentation Request
17+
description: Request additions to __PROJECT__ documentation
18+
title: "[DOC]: "
19+
labels: ["doc"]
20+
21+
body:
22+
- type: markdown
23+
attributes:
24+
value: |
25+
Thanks for taking the time to improve our documentation!
26+
27+
- type: dropdown
28+
id: criticality
29+
attributes:
30+
label: How would you describe the priority of this documentation request
31+
options:
32+
- Critical (currently preventing usage)
33+
- High
34+
- Medium
35+
- Low (would be nice)
36+
validations:
37+
required: true
38+
39+
- type: textarea
40+
id: problem
41+
attributes:
42+
label: Describe the future/missing documentation
43+
placeholder: A code snippet mentions function foo(args) but I cannot find any documentation on it.
44+
validations:
45+
required: true
46+
47+
- type: textarea
48+
id: search_locs
49+
attributes:
50+
label: Where have you looked?
51+
placeholder: |
52+
https://github.com/rapidsai/rapids-repo-template/blob/main/README.md
53+
54+
- type: checkboxes
55+
id: terms
56+
attributes:
57+
label: Code of Conduct
58+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/rapidsai/rapids-repo-template/blob/main/CODE_OF_CONDUCT.md)
59+
options:
60+
- label: I agree to follow __PROJECT__'s Code of Conduct
61+
required: true
62+
- label: I have searched the [open documentation issues](https://github.com/rapidsai/rapids-repo-template/issues?q=is%3Aopen+is%3Aissue+label%3Adoc) and have found no duplicates for this bug report
63+
required: true

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for ___PROJECT___
4+
title: "[FEA]"
5+
labels: "? - Needs Triage, feature request"
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I wish I could use ___PROJECT___ to do [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context, code examples, or references to existing implementations about the feature request here.
21+
22+
-----
23+
By submitting this issue, you agree to follow our [code of conduct](https://docs.rapids.ai/resources/conduct/) and our [contributing guidelines](https://github.com/jarmak-nv/rapids-repo-template/blob/main/CONTRIBUTING.md).

0 commit comments

Comments
 (0)