Skip to content

Commit 7d14e82

Browse files
committed
feat: add CONTRIBUTING.md
1 parent 6aba159 commit 7d14e82

1 file changed

Lines changed: 50 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Contributing
2+
3+
Contributions are welcome. This toolkit is a living index of AMD Windows AI resources.
4+
5+
## What We Accept
6+
7+
- New repos added to the ecosystem table
8+
- Fixes to broken links or outdated versions
9+
- Better GPU detection logic for `doctor.py` or `check_gpu.py`
10+
- New scripts useful across the ecosystem (benchmarking, model management, etc.)
11+
- Documentation improvements
12+
- Verified test results on new AMD GPU models
13+
14+
## How to Contribute
15+
16+
1. Fork the repo
17+
2. Create a branch: `git checkout -b feat/your-feature`
18+
3. Make your changes
19+
4. Test on an AMD GPU on Windows if possible
20+
5. Submit a pull request with a clear description
21+
22+
## Adding a Repo to the Ecosystem Table
23+
24+
If you have a repo that helps AMD GPU users on Windows:
25+
26+
1. Open an issue using the Feature Request template
27+
2. Include: repo URL, what it does, which backend it uses (DirectML / Vulkan)
28+
3. We'll verify it works before adding it to the table
29+
30+
## Code Style
31+
32+
- Python 3.10+ compatible
33+
- No external dependencies for diagnostic scripts (`doctor.py`, `check_gpu.py`, `check_gpu.py`)
34+
- Standard library only for the core toolkit; use `try_import` pattern for optional packages
35+
- Docstring at the top of each script with usage example
36+
37+
## Reporting Issues
38+
39+
Use the [Bug Report template](.github/ISSUE_TEMPLATE/bug_report.md) and include:
40+
- GPU model and VRAM
41+
- AMD driver version
42+
- Windows version
43+
- Python version
44+
- Full error output
45+
46+
The output of `python scripts\doctor.py` covers most of these automatically.
47+
48+
## License
49+
50+
By contributing you agree your code will be released under the [MIT License](LICENSE).

0 commit comments

Comments
 (0)