oneapi-src / oneapi-src/level-zero
Explicitly state that MacOS is not supported
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 335
- Forks
- 140
- Avg merge
- 12h 32m
- Merged PRs (30d)
- 5
Description
Hi there,
I know it is not a very useful change for the project but it would be convenient if the project's readme stated clearly that MacOS is not supported (or that only Linux and Windows are supported).
For context: there are a few package managers that have level-zero as a package. Conan, for example.
Conan has a rather old version of level-zero and updating it stuck on the fact that macOS build in CI is failing.
The maintainer is reluctant to explicitly mark no support for macOS even thought MacOS build has not much purpose.
On the other hand one can understand the maintainer, cause the project doesn't articulate the lack of support for MacOS in any explicit way and even has some comments in code implying that developers had it in mind when the code was written.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the project's README, which the issue identifies as the place needing clarification. Add an explicit statement that macOS is unsupported, or that only Linux and Windows are supported, and verify that the support status is unambiguous to package maintainers.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 76/100