Skip to content

Commit ea07062

Browse files
harrismharrism
committed
Added github templates and print_env script
1 parent 58b188e commit ea07062

File tree

6 files changed

+206
-0
lines changed

6 files changed

+206
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: Bug report
3+
about: Create a bug report to help us improve RMM
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 RMM install: [conda, Docker, or from source]
22+
- If method of install is [Docker], provide `docker pull` & `docker run` commands used
23+
- Please run and attach the output of the `rmm/print_env.sh` script to gather relevant environment details
24+
25+
26+
**Additional context**
27+
Add any other context about the problem here.

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

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
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+
## Report incorrect documentation
11+
12+
**Location of incorrect documentation**
13+
Provide links and line numbers if applicable.
14+
15+
**Describe the problems or issues found in the documentation**
16+
A clear and concise description of what you found to be incorrect.
17+
18+
**Steps taken to verify documentation is incorrect**
19+
List any steps you have taken.
20+
21+
**Suggested fix for documentation**
22+
Detail proposed changes to fix the documentation if you have any.
23+
24+
---
25+
26+
## Report needed documentation
27+
28+
**Report needed documentation**
29+
A clear and concise description of what documentation is needed and why.
30+
31+
**Steps taken to search for needed documentation**
32+
List any steps you have taken.
33+

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for RMM
4+
title: "[FEA]"
5+
labels: "? - Needs Triage, doc"
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 RMM 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.

‎.github/ISSUE_TEMPLATE/submit-question.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
name: Submit question
3+
about: Ask a general question about RMM
4+
title: "[QST]"
5+
labels: "? - Needs Triage, question"
6+
assignees: ''
7+
8+
---
9+
10+
**What is your question?**

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
<!--
2+
3+
Thanks for wanting to contribute to RMM :) Please read these instructions and
4+
replace them with your description.
5+
6+
First, if you need some help or want to chat to the core developers, please
7+
visit https://rapids.ai/community.html for links to our Google Group and other
8+
communication channels.
9+
10+
Here's some guidelines to help the review process go smoothly.
11+
12+
0. Please write a description in this text box of the changes that are being
13+
made.
14+
15+
1. Please ensure that you have written units tests for the changes made and/or
16+
features added.
17+
18+
2. If you are closing an issue please use one of the automatic closing words as
19+
noted here: https://help.github.com/articles/closing-issues-using-keywords/
20+
21+
3. If your pull request is not ready for review but you want to make use of the
22+
continuous integration testing facilities please label it with `[WIP]`.
23+
24+
4. If your pull request is ready to be reviewed without requiring additional
25+
work on top of it, then remove the `[WIP]` label (if present) and replace
26+
it with `[REVIEW]`. If assistance is required to complete the functionality,
27+
for example when the C/C++ code of a feature is complete but Python bindings
28+
are still required, then add the label `[HELP-REQ]` so that others can triage
29+
and assist. The additional changes then can be implemented on top of the
30+
same PR. If the assistance is done by members of the rapidsAI team, then no
31+
additional actions are required by the creator of the original PR for this,
32+
otherwise the original author of the PR needs to give permission to the
33+
person(s) assisting to commit to their personal fork of the project. If that
34+
doesn't happen then a new PR based on the code of the original PR can be
35+
opened by the person assisting, which then will be the PR that will be
36+
merged.
37+
38+
5. Once all work has been done and review has taken place please do not add
39+
features or make changes out of the scope of those requested by the reviewer
40+
(doing this just adds delays as already reviewed code ends up having to be
41+
re-reviewed/it is hard to tell what is new etc!). Further, please do not
42+
rebase your branch on master/force push/rewrite history, doing any of these
43+
causes the context of any comments made by reviewers to be lost. If
44+
conflicts occur against the release or master branch they should be resolved
45+
by merging master into the branch used for making the pull request.
46+
47+
Many thanks in advance for your cooperation!
48+
49+
-->

‎print_env.sh‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
#!/usr/bin/env bash
2+
# Reports relevant environment information useful for diagnosing and
3+
# debugging cuDF issues.
4+
# Usage:
5+
# "./print_env.sh" - prints to stdout
6+
# "./print_env.sh > env.txt" - prints to file "env.txt"
7+
8+
echo "**git***"
9+
git log --decorate -n 1
10+
echo
11+
12+
echo "***OS Information***"
13+
cat /etc/*-release
14+
uname -a
15+
echo
16+
17+
echo "***GPU Information***"
18+
nvidia-smi
19+
echo
20+
21+
echo "***CPU***"
22+
lscpu
23+
echo
24+
25+
echo "***CMake***"
26+
which cmake && cmake --version
27+
echo
28+
29+
echo "***g++***"
30+
which g++ && g++ --version
31+
echo
32+
33+
echo "***nvcc***"
34+
which nvcc && nvcc --version
35+
echo
36+
37+
echo "***Python***"
38+
which python && python --version
39+
echo
40+
41+
echo "***Environment Variables***"
42+
43+
printf '%-32s: %s\n' PATH $PATH
44+
45+
printf '%-32s: %s\n' LD_LIBRARY_PATH $LD_LIBRARY_PATH
46+
47+
printf '%-32s: %s\n' NUMBAPRO_NVVM $NUMBAPRO_NVVM
48+
49+
printf '%-32s: %s\n' NUMBAPRO_LIBDEVICE $NUMBAPRO_LIBDEVICE
50+
51+
printf '%-32s: %s\n' CONDA_PREFIX $CONDA_PREFIX
52+
53+
printf '%-32s: %s\n' PYTHON_PATH $PYTHON_PATH
54+
55+
echo
56+
57+
# Print conda packages if conda exists
58+
if type "conda" > /dev/null; then
59+
echo '***conda packages***'
60+
which conda && conda list
61+
echo
62+
# Print pip packages if pip exists
63+
elif type "pip" > /dev/null; then
64+
echo "***pip packages***"
65+
which pip && pip list
66+
echo
67+
fi

0 commit comments

Comments
 (0)