Merge pull request #5 from nv-rliu/branch-24.12-setup-repo

Setting Up New Repo, Adding Files, etc.

.flake8

@@ -1,25 +1,16 @@
-# Copyright (c) 2022, NVIDIA CORPORATION.
+# Copyright (c) 2023-2024, NVIDIA CORPORATION.
 
 [flake8]
-filename = *.py, *.pyx, *.pxd, *.pxi
-exclude = __init__.py, *.egg, build, docs, .git
-force-check = True
 max-line-length = 88
-ignore =
-    # line break before binary operator
-    W503,
-    # whitespace before :
-    E203
+inline-quotes = "
+extend-ignore =
+    B020,
+    E203,
+    SIM105,
+    SIM401,
+# E203 whitespace before ':' (to be compatible with black)
 per-file-ignores =
-    # Rules ignored only in Cython:
-    # E211: whitespace before '(' (used in multi-line imports)
-    # E225: Missing whitespace around operators (breaks cython casting syntax like <int>)
-    # E226: Missing whitespace around arithmetic operators (breaks cython pointer syntax like int*)
-    # E227: Missing whitespace around bitwise or shift operator (Can also break casting syntax)
-    # E275: Missing whitespace after keyword (Doesn't work with Cython except?)
-    # E402: invalid syntax (works for Python, not Cython)
-    # E999: invalid syntax (works for Python, not Cython)
-    # W504: line break after binary operator (breaks lines that end with a pointer)
-    *.pyx: E211, E225, E226, E227, E275, E402, E999, W504
-    *.pxd: E211, E225, E226, E227, E275, E402, E999, W504
-    *.pxi: E211, E225, E226, E227, E275, E402, E999, W504
+    nx_cugraph/tests/*.py:T201,
+    __init__.py:F401,F403,
+    _nx_cugraph/__init__.py:E501,
+    nx_cugraph/__init__.py:E402,F401,F403,

.github/CODEOWNERS

@@ -1,23 +1,28 @@
 # https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners
 # Order matters - match of highest importance goes last (last match wins)
 
-
-# doc code owners
-#
-
-
-# python code owners
-# example
-# python/nx_cugraph			@rapidsai/nx-cugraph-python-codeowners
-
-
-# CI code owners
-# /ci/			@rapidsai/ci-codeowners
-
-
-# packaging code owners
-# /conda/            @rapidsai/packaging-codeowners
-# /dependencies.yaml @rapidsai/packaging-codeowners
-# /build.sh          @rapidsai/packaging-codeowners
-# pyproject.toml     @rapidsai/packaging-codeowners
-# VERSION            @rapidsai/packaging-codeowners
+#doc code owners
+datasets/          @rapidsai/nx-cugraph-doc-codeowners
+docs/              @rapidsai/nx-cugraph-doc-codeowners
+**/*.txt           @rapidsai/nx-cugraph-doc-codeowners
+notebooks/         @rapidsai/nx-cugraph-doc-codeowners
+**/*.md            @rapidsai/nx-cugraph-doc-codeowners
+**/*.rst           @rapidsai/nx-cugraph-doc-codeowners
+**/*.ipynb         @rapidsai/nx-cugraph-doc-codeowners
+**/*.pdf           @rapidsai/nx-cugraph-doc-codeowners
+**/*.png           @rapidsai/nx-cugraph-doc-codeowners
+
+#python code owners
+python/            @rapidsai/nx-cugraph-python-codeowners
+
+#CI code owners
+/.github/                @rapidsai/ci-codeowners
+/ci/                     @rapidsai/ci-codeowners
+/.pre-commit-config.yaml @rapidsai/ci-codeowners
+
+#packaging code owners
+/.devcontainer/    @rapidsai/packaging-codeowners
+/conda/            @rapidsai/packaging-codeowners
+/dependencies.yaml @rapidsai/packaging-codeowners
+/build.sh          @rapidsai/packaging-codeowners
+pyproject.toml     @rapidsai/packaging-codeowners

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -0,0 +1,94 @@
+# SPDX-FileCopyrightText: Copyright (c) 2022-2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# 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.
+
+name: Bug Report
+description: File a bug report for nx-cugraph
+title: "[BUG]: "
+labels: ["bug", "? - Needs Triage"]
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to help nx-cugraph and fill out this bug report!
+
+  - type: input
+    id: version
+    attributes:
+      label: Version
+      description: What version of nx-cugraph are you running?
+      placeholder: "example: 24.12"
+    validations:
+      required: true
+
+  - type: dropdown
+    id: installation-method
+    attributes:
+      label: Which installation method(s) does this occur on?
+      multiple: true
+      options:
+        - Conda
+        - Pip
+        - Source
+
+  - type: textarea
+    id: description
+    attributes:
+      label: Describe the bug.
+      description: Also tell us, what did you expect to happen?
+      placeholder: XYZ occured, I expected QRS results
+    validations:
+      required: true
+
+  - type: textarea
+    id: mvr
+    attributes:
+      label: Minimum reproducible example
+      description: Please supply a [minimum reproducible code example](https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) here
+      render: shell
+
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: Please paste relevant error and log output here
+      render: shell
+
+  - type: textarea
+    id: env-details
+    attributes:
+      label: Environment details
+      description: Please provide any relevant environment details
+      placeholder: |
+        Please run and paste the output of the `nx-cugraph/print_env.sh` script here.
+        The script gathers any other relevant environment details.
+      render: shell
+
+  - type: textarea
+    id: misc
+    attributes:
+      label: Other/Misc.
+      description: Please enter any other helpful information here.
+
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](https://docs.rapids.ai/resources/conduct/)
+      options:
+        - label: I agree to follow nx-cugraph's Code of Conduct
+          required: true
+        - label: I have searched the [open bugs](https://github.com/rapidsai/nx-cugraph/issues?q=is%3Aopen+is%3Aissue+label%3Abug) and have found no duplicates for this bug report
+          required: true

.github/ISSUE_TEMPLATE/docs_request_correction.yaml

@@ -0,0 +1,70 @@
+# SPDX-FileCopyrightText: Copyright (c) 2022-2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# 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.
+
+name: Documentation - Correction/Update Request
+description: Request corrections or updates to existing nx-cugraph documentation
+title: "[DOC]: "
+labels: ["doc", "? - Needs Triage"]
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to help nx-cugraph and improve our documentation!
+
+  - type: dropdown
+    id: criticality
+    attributes:
+      label: How would you describe the priority of this documentation request
+      options:
+        - Critical (currently preventing usage)
+        - High
+        - Medium
+        - Low (would be nice)
+    validations:
+      required: true
+
+  - type: input
+    id: correction_location
+    attributes:
+      label: Please provide a link or source to the relevant docs
+      placeholder: "ex: https://docs.rapids.ai/api/cugraph/stable/installation/"
+    validations:
+      required: true
+
+  - type: textarea
+    id: problem
+    attributes:
+      label: Describe the problems in the documentation
+      placeholder: The documents say to use foo.func(args) however an AttributeError is thrown
+    validations:
+      required: true
+
+  - type: textarea
+    id: correction
+    attributes:
+      label: (Optional) Propose a correction
+      placeholder: foo.func() was deprecated, replace documentation with foo.new_func()
+
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](https://docs.rapids.ai/resources/conduct/)
+      options:
+        - label: I agree to follow nx-cugraph's Code of Conduct
+          required: true
+        - label: I have searched the [open documentation issues](https://github.com/rapidsai/nx-cugraph/issues?q=is%3Aopen+is%3Aissue+label%3Adoc) and have found no duplicates for this bug report
+          required: true

.github/ISSUE_TEMPLATE/docs_request_new.yaml

@@ -0,0 +1,64 @@
+# SPDX-FileCopyrightText: Copyright (c) 2022-2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# 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.
+
+name: Documentation - New Documentation Request
+description: Request additions to nx-cugraph's documentation
+title: "[DOC]: "
+labels: ["doc", "? - Needs Triage"]
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to help nx-cugraph and improve our documentation!
+
+  - type: dropdown
+    id: criticality
+    attributes:
+      label: How would you describe the priority of this documentation request
+      options:
+        - Critical (currently preventing usage)
+        - High
+        - Medium
+        - Low (would be nice)
+    validations:
+      required: true
+
+  - type: textarea
+    id: problem
+    attributes:
+      label: Describe the future/missing documentation
+      placeholder: A code snippet mentions function foo(args) but I cannot find any documentation on it.
+    validations:
+      required: true
+
+  - type: textarea
+    id: search_locs
+    attributes:
+      label: Where have you looked?
+      placeholder: |
+       https://docs.rapids.ai/api/cugraph/stable/nx_cugraph and
+       https://docs.rapids.ai/api/cugraph/nightly/nx_cugraph
+
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](https://docs.rapids.ai/resources/conduct/)
+      options:
+        - label: I agree to follow nx-cugraph's Code of Conduct
+          required: true
+        - label: I have searched the [open documentation issues](https://github.com/rapidsai/nx-cugraph/issues?q=is%3Aopen+is%3Aissue+label%3Adoc) and have found no duplicates for this bug report
+          required: true