Open Source Contributions (#750)

* Create CONTRIBUTING.md Adding ROCm needed files for Open source development. * Create CODEOWNERS * Adding issue templates * Addressing review comments --------- Co-authored-by: Ammar ELWazir <[email protected]> Co-authored-by: gobhardw <[email protected]>
ROCm · Jul 18, 2024 · b8a22e6 · b8a22e6
1 parent 785cc39
commit b8a22e6
Show file tree

Hide file tree

Showing 6 changed files with 249 additions and 0 deletions.
diff --git a/CODEOWNERS b/CODEOWNERS
@@ -0,0 +1 @@
+* @jrmadsen @bwelton @ammarwa @bgopesh @SrirakshaNag @vlaindic @ApoKalipse-V @MythreyaK @pbhandar-amd @sauverma93 @t-tye
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,41 @@
+# Contributing to ROCProfiler SDK #
+
+Contributions are welcome. Contributions at a basic level must conform to the MIT license and pass code test requirements (i.e. ctest). The author must also be able to respond to comments/questions on the PR and make any changes requested.
+
+## Issue Discussion ##
+
+Please use the GitHub Issues tab to let us know of any issues.
+
+* Use your best judgment when creating issues. If your issue is already listed, please upvote the issue and
+comment or post to provide additional details, such as the way to reproduce this issue.
+* If you're unsure if your issue is the same, err on caution and file your issue.
+  You can add a comment to include the issue number (and link) for a similar issue. If we evaluate
+  your issue as being the same as the existing issue, we'll close the duplicate.
+* If your issue doesn't exist, use the issue template to file a new issue.
+  * When you file an issue, please provide as much information as possible, including script output, so
+we can get information about your configuration. This helps reduce the time required to
+    reproduce your issue.
+  * Check your issue regularly, as we may require additional information to reproduce the
+issue successfully.
+* You may also open an issue to ask the maintainers whether a proposed change
+meets the acceptance criteria or to discuss an idea about the library.
+
+## Acceptance Criteria ##
+
+Github issues are recommended for any significant change to the code base that adds a feature or fixes a non-trivial issue. If the code change is large without the presence of an issue (or prior discussion with AMD), the change may not be reviewed. Small fixes that fix broken behavior or other bugs are always welcome with or without an associated issue.
+
+## Coding Style ##
+
+All changes must be formatted with clang-format-15/cmake-format before review/acceptance. The exact settings for these formatters must be the ones in this repository.
+
+## Pull Request Guidelines ##
+
+By creating a pull request, you agree to the statements made in the [code license](#code-license) section. Your pull request should target the default branch. Our current default branch is the **develop** branch, which serves as our integration branch.
+
+## Code License ##
+
+All code contributed to this project will be licensed under the license identified in the [License.txt](../LICENSE.txt). Your contribution will be accepted under the same license.
+
+## Release Cadence ##
+
+Any code contribution to this library will be released with the next version of ROCm if the contribution window for the upcoming release is still open. If the contribution window is closed but the PR contains a critical security/bug fix, an exception may be made to include the change in the next release.
diff --git a/ISSUE_TEMPLATE/config.yml b/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1 @@
+blank_issues_enabled: true
diff --git a/ISSUE_TEMPLATE/documentation_template.yml b/ISSUE_TEMPLATE/documentation_template.yml
@@ -0,0 +1,14 @@
+name: Documentation Fixes
+description: Documentation errors can be reported here.
+title: "[Documentation]: "
+body:
+- type: textarea
+  attributes:
+    label: Description of errors
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Attach any links, screenshots, or additional evidence you think will be helpful.
+  validations:
+    required: false
diff --git a/ISSUE_TEMPLATE/feature_request.yml b/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,32 @@
+name: Feature Suggestion
+description: Suggest an additional functionality, or new way of handling an existing functionality.
+title: "[Feature]: "
+
+body:
+- type: markdown
+  attributes:
+    value: |
+      Thank you for taking the time to make a suggestion!
+
+- type: textarea
+  attributes:
+    label: Suggestion Description
+    description: Describe your suggestion.
+  validations:
+    required: true
+- type: input
+  attributes:
+    label: Operating System
+    description: (Optional) If this is for a specific OS, you can mention it here.
+    placeholder: "e.g. Ubuntu"
+- type: input
+  attributes:
+    label: GPU
+    description: (Optional) If this is for a specific GPU or GPU family, you can mention it here.
+    placeholder: "e.g. MI200"
+- type: input
+  attributes:
+    label: ROCm Component
+    description: (Optional) If this issue relates to a specific ROCm component, it can be mentioned here.
+    placeholder: "e.g. rocBLAS"
+
diff --git a/ISSUE_TEMPLATE/issue_report.yml b/ISSUE_TEMPLATE/issue_report.yml
@@ -0,0 +1,160 @@
+name: Issue Report
+description: File a report for ROCm related issues on Linux and Windows. For issues pertaining to documentation or non-bug related, please open a blank issue located below.
+title: "[Issue]: "
+
+body:
+- type: markdown
+  attributes:
+    value: |
+      Thank you for taking the time to fill out this report!
+
+      You can acquire your OS, CPU, GPU (for filling out this report) with the following commands:
+
+      Linux:
+      ```
+        echo "OS:" && cat /etc/os-release | grep -E "^(NAME=|VERSION=)";
+        echo "CPU: " && cat /proc/cpuinfo | grep "model name" | sort --unique;
+        echo "GPU:" && /opt/rocm/bin/rocminfo | grep -E "^\s*(Name|Marketing Name)";
+      ```
+        
+      Windows:
+      ```
+        (Get-WmiObject Win32_OperatingSystem).Version
+        (Get-WmiObject win32_Processor).Name
+        (Get-WmiObject win32_VideoController).Name
+      ```
+- type: textarea
+  attributes:
+    label: Problem Description
+    description: Describe the issue you encountered.
+  validations:
+    required: true
+- type: input
+  attributes:
+    label: Operating System
+    description: What is the name and version number of the OS?
+    placeholder: "e.g. Ubuntu 22.04.3 LTS (Jammy Jellyfish)"
+  validations:
+    required: true
+- type: input
+  attributes:
+    label: CPU
+    description: What CPU did you encounter the issue on?
+    placeholder: "e.g. AMD Ryzen 9 5900HX with Radeon Graphics"
+  validations:
+    required: true
+- type: dropdown
+  attributes:
+    label: GPU
+    description: What GPU(s) did you encounter the issue on (you can select multiple GPUs from the list)
+    multiple: true
+    options:
+        - AMD Instinct MI300X
+        - AMD Instinct MI300A
+        - AMD Instinct MI250X
+        - AMD Instinct MI250
+        - AMD Instinct MI210
+        - AMD Instinct MI100
+        - AMD Radeon Pro W7900
+        - AMD Radeon Pro W6800
+        - AMD Radeon Pro V620
+        - AMD Radeon Pro VII
+        - AMD Radeon RX 7900 XTX
+        - AMD Radeon RX 7900 XT
+        - AMD Radeon VII
+  validations:
+    required: true
+- type: dropdown
+  attributes:
+    label: ROCm Version
+    description: What version(s) of ROCm did you encounter the issue on?
+    multiple: true
+    options:
+        - ROCm 6.0.0
+        - ROCm 5.7.1
+        - ROCm 5.7.0
+        - ROCm 5.6.0
+        - ROCm 5.5.1
+        - ROCm 5.5.0
+  validations:
+    required: true
+- type: dropdown
+  attributes:
+    label: ROCm Component
+    description: (Optional) If this issue relates to a specific ROCm component, it can be mentioned here.
+    options:
+      - AMDMIGraphX
+      - amdsmi
+      - aomp
+      - aomp-extras
+      - clang-ocl
+      - clr
+      - composable_kernel
+      - flang
+      - half
+      - HIP
+      - hipBLAS
+      - HIPCC
+      - hipCUB
+      - HIP-Examples
+      - hipFFT
+      - hipfort
+      - HIPIFY
+      - hipSOLVER
+      - hipSPARSE
+      - hipTensor
+      - llvm-project
+      - MIOpen
+      - MIVisionX
+      - rccl
+      - rdc
+      - rocALUTION
+      - rocBLAS
+      - ROCdbgapi
+      - rocFFT
+      - ROCgdb
+      - ROCK-Kernel-Driver
+      - ROCm
+      - rocm_bandwidth_test
+      - rocm_smi_lib
+      - rocm-cmake
+      - ROCm-CompilerSupport
+      - rocm-core
+      - ROCm-Device-Libs
+      - rocminfo
+      - rocMLIR
+      - ROCmValidationSuite
+      - rocPRIM
+      - rocprofiler
+      - rocr_debug_agent
+      - rocRAND
+      - ROCR-Runtime
+      - rocSOLVER
+      - rocSPARSE
+      - rocThrust
+      - roctracer
+      - ROCT-Thunk-Interface
+      - rocWMMA
+      - rpp
+      - Tensile
+    multiple: true
+- type: textarea
+  attributes:
+    label: Steps to Reproduce
+    description: (Optional) Detailed steps to reproduce the issue.
+  validations:
+    required: false
+
+- type: textarea
+  attributes:
+    label: (Optional for Linux users) Output of /opt/rocm/bin/rocminfo --support
+    description: The output of rocminfo --support could help to better address the problem.
+  validations:
+    required: false
+
+- type: textarea
+  attributes:
+    label: Additional Information
+    description: (Optional) Any additional information that is relevant, e.g. relevant environment variables, dockerfiles, log files, dmesg output (on Linux), etc.
+  validations:
+    required: false
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		* @jrmadsen @bwelton @ammarwa @bgopesh @SrirakshaNag @vlaindic @ApoKalipse-V @MythreyaK @pbhandar-amd @sauverma93 @t-tye