Adds CODEOWNERS and other .github template files. (nv-morpheus#12)

AyodeAwe · Jun 8, 2022 · 65ff7ba · 65ff7ba
1 parent 3fb16a8
commit 65ff7ba
Show file tree

Hide file tree

Showing 8 changed files with 217 additions and 1 deletion.
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -0,0 +1,14 @@
+# Default Approval rule if one of the later sections does not apply
+* @nv-morpheus/srf-codeowners
+
+# Approval from Python codeowners is required for these files
+/python/     @nv-morpheus/srf-codeowners-python
+
+# Approval from C++ codeowners is required for these files
+/benchmarks/ @nv-morpheus/srf-codeowners-cpp
+/cmake/      @nv-morpheus/srf-codeowners-cpp
+/include/    @nv-morpheus/srf-codeowners-cpp
+/protos/     @nv-morpheus/srf-codeowners-cpp
+/src/        @nv-morpheus/srf-codeowners-cpp
+/tests/      @nv-morpheus/srf-codeowners-cpp
+/tools/      @nv-morpheus/srf-codeowners-cpp
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,28 @@
+---
+name: Bug report
+about: Create a bug report to help us improve SRF
+title: "[BUG]"
+labels: "? - Needs Triage, bug"
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**Steps/Code to reproduce bug**
+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.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Environment overview (please complete the following information)**
+ - Environment location: [Bare-metal, Docker, Cloud(specify cloud provider)]
+ - Method of SRF install: [conda, Docker, or from source]
+   - If method of install is [Docker], provide `docker pull` & `docker run` commands used
+
+**Environment details**
+Please run and paste the output of the `./scripts/print_env.sh` script here, to gather any other relevant environment details
+
+**Additional context**
+Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/documentation-request.md b/.github/ISSUE_TEMPLATE/documentation-request.md
@@ -0,0 +1,35 @@
+---
+name: Documentation request
+about: Report incorrect or needed documentation
+title: "[DOC]"
+labels: "? - Needs Triage, doc"
+assignees: ''
+
+---
+
+## Report incorrect documentation
+
+**Location of incorrect documentation**
+Provide links and line numbers if applicable.
+
+**Describe the problems or issues found in the documentation**
+A clear and concise description of what you found to be incorrect.
+
+**Steps taken to verify documentation is incorrect**
+List any steps you have taken:
+
+**Suggested fix for documentation**
+Detail proposed changes to fix the documentation if you have any.
+
+---
+
+## Report needed documentation
+
+**Report needed documentation**
+A clear and concise description of what documentation you believe it is needed and why.
+
+**Describe the documentation you'd like**
+A clear and concise description of what you want to happen.
+
+**Steps taken to search for needed documentation**
+List any steps you have taken:
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for SRF
+title: "[FEA]"
+labels: "? - Needs Triage, feature request"
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I wish I could use SRF to do [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context, code examples, or references to existing implementations about the feature request here.
diff --git a/.github/ISSUE_TEMPLATE/submit-question.md b/.github/ISSUE_TEMPLATE/submit-question.md
@@ -0,0 +1,10 @@
+---
+name: Submit question
+about: Ask a general question about SRF
+title: "[QST]"
+labels: "? - Needs Triage, question"
+assignees: ''
+
+---
+
+**What is your question?**
diff --git a/.github/ops-bot.yaml b/.github/ops-bot.yaml
@@ -0,0 +1,8 @@
+# This file controls which features from the `ops-bot` repository below are enabled.
+# - https://github.com/rapidsai/ops-bot
+
+auto_merger: true
+branch_checker: true
+label_checker: true
+release_drafter: true
+external_contributors: false
diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt
@@ -25,7 +25,7 @@ set(DOXYGEN_RECURSIVE YES)
 set(DOXYGEN_FILE_PATTERNS "*.c; *.cc; *.cpp; *.h; *.hpp; *.cu; *.cuh; *.md")
 set(DOXYGEN_SOURCE_BROWSER YES)
 set(DOXYGEN_PROJECT_NAME "SRF")
-set(DOXYGEN_PROJECT_BRIEF "Morpheus Streaming Library")
+set(DOXYGEN_PROJECT_BRIEF "Streaming Reactive Framework")
 set(DOXYGEN_EXTENSION_MAPPING "cu=C++; cuh=C++")
 set(DOXYGEN_BRIEF_MEMBER_DESC YES)
 set(DOXYGEN_HIDE_UNDOC_MEMBERS NO)

diff --git a/scripts/print_env.sh b/scripts/print_env.sh
@@ -0,0 +1,101 @@
+#!/usr/bin/env bash
+# Copyright (c) 2021-2022, NVIDIA CORPORATION.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Reports relevant environment information useful for diagnosing and
+# debugging cuDF issues.
+# Usage:
+# "./print_env.sh" - prints to stdout
+# "./print_env.sh > env.txt" - prints to file "env.txt"
+
+print_env() {
+echo "**git***"
+if [ "$(git rev-parse --is-inside-work-tree 2>/dev/null)" == "true" ]; then
+git log --decorate -n 1
+echo "**git submodules***"
+git submodule status --recursive
+else
+echo "Not inside a git repository"
+fi
+echo
+
+echo "***OS Information***"
+cat /etc/*-release
+uname -a
+echo
+
+echo "***GPU Information***"
+nvidia-smi
+echo
+
+echo "***CPU***"
+lscpu
+echo
+
+echo "***CMake***"
+which cmake && cmake --version
+echo
+
+echo "***g++***"
+which g++ && g++ --version
+echo
+
+echo "***nvcc***"
+which nvcc && nvcc --version
+echo
+
+echo "***Python***"
+which python && python -c "import sys; print('Python {0}.{1}.{2}'.format(sys.version_info[0], sys.version_info[1], sys.version_info[2]))"
+echo
+
+echo "***Environment Variables***"
+
+printf '%-32s: %s\n' PATH $PATH
+
+printf '%-32s: %s\n' LD_LIBRARY_PATH $LD_LIBRARY_PATH
+
+printf '%-32s: %s\n' NUMBAPRO_NVVM $NUMBAPRO_NVVM
+
+printf '%-32s: %s\n' NUMBAPRO_LIBDEVICE $NUMBAPRO_LIBDEVICE
+
+printf '%-32s: %s\n' CONDA_PREFIX $CONDA_PREFIX
+
+printf '%-32s: %s\n' PYTHON_PATH $PYTHON_PATH
+
+echo
+
+
+# Print conda packages if conda exists
+if type "conda" &> /dev/null; then
+echo '***conda packages***'
+which conda && conda list
+echo
+# Print pip packages if pip exists
+elif type "pip" &> /dev/null; then
+echo "conda not found"
+echo "***pip packages***"
+which pip && pip list
+echo
+else
+echo "conda not found"
+echo "pip not found"
+fi
+}
+
+echo "<details><summary>Click here to see environment details</summary><pre>"
+echo "     "
+print_env | while read -r line; do
+    echo "     $line"
+done
+echo "</pre></details>"