Skip to content

Commit f71feb6

Browse files
committed
wsl/librocdxg: add CONTRIBUTING.md
Signed-off-by: Flora Cui <flora.cui@amd.com>
1 parent a056d80 commit f71feb6

File tree

2 files changed

+28
-1
lines changed

2 files changed

+28
-1
lines changed

CONTRIBUTING.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Contributing to AMD ROCDXG Libary
2+
3+
Thanks for your interest in improving librocdxg! This guide explains how to set up development environment, propose changes, and submit pull requests.
4+
5+
## Quick Start
6+
- Fork the repo and create a feature branch.
7+
- Build and test inside WSL2 (Ubuntu 22.04/24.04).
8+
- Keep PRs focused and well-described; link related issues.
9+
- Ensure changes align with license terms (see Licensing).
10+
11+
## Issues and Discussions
12+
- Before filing an issue, search existing issues.
13+
- Bug reports should include:
14+
- Host Windows version, WSL Ubuntu version, compiler, and CMake versions
15+
- Windows display driver version and ROCm version
16+
- Exact build commands and `WIN_SDK` path used
17+
- Minimal repro steps and expected vs. actual behavior
18+
- Logs from relevant modules
19+
- Feature requests should explain use-cases and expected API changes.
20+
21+
## Licensing
22+
- Most source files are licensed under MIT as described in [LICENSE.md](LICENSE.md).
23+
- The binary `src/thunk_proxy/libthunk_proxy.a` is under an AMD proprietary license with redistribution restrictions (see [LICENSE.md](LICENSE.md)). Do not attempt to reverse engineer or modify this binary.
24+
- By submitting a contribution, you agree that your changes are licensed under the MIT terms applicable to this repository, unless explicitly stated otherwise by the maintainers.

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,4 +138,7 @@ See [Installing the all open use case](https://amdgpu-install.readthedocs.io/en/
138138
| 1.0.0 | 7.1 | AMD Windows x86 drivers can be directly downloaded from [AMD Driver](https://www.amd.com/en/support/download/drivers.html) | ***Radeon***<br><br>AMD Radeon RX 9070<br>AMD Radeon RX 9070 XT<br>AMD Radeon RX 9070 GRE<br>AMD Radeon AI PRO R9700<br>AMD Radeon RX 9060<br>AMD Radeon RX 9060 XT<br>AMD Radeon RX 7900 XTX<br>AMD Radeon RX 7900 XT<br>AMD Radeon RX 7900 GRE<br>AMD Radeon PRO W7900<br>AMD Radeon PRO W7900 Dual Slot<br>AMD Radeon PRO W7800<br>AMD Radeon PRO W7800 48GB<br>AMD Radeon RX 7800 XT<br>AMD Radeon PRO W7700<br><br>***Ryzen***<br><br>AMD Ryzen AI Max+ 395<br>AMD Ryzen AI Max 390<br>AMD Ryzen AI Max 385<br>AMD Ryzen AI 9 HX 375<br>AMD Ryzen AI 9 HX 370<br>AMD Ryzen AI 9 365 |
139139

140140
## Documentation
141-
For detailed documentation including installation guides, configuration options, and metric descriptions, please refer to [Use ROCm on Radeon and Ryzen](https://rocm.docs.amd.com/projects/radeon-ryzen/en/latest/index.html#)
141+
For detailed documentation including installation guides, configuration options, and metric descriptions, please refer to [Use ROCm on Radeon and Ryzen](https://rocm.docs.amd.com/projects/radeon-ryzen/en/latest/index.html#)
142+
143+
## Contributing
144+
See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on setting up your WSL environment, building, and submitting pull requests.

0 commit comments

Comments
 (0)