rapidsai / rapidsai/devcontainers

[DOC] rapids-build-utils could use documentation

Open
#170 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Shell
Stars
28
Forks
47
Avg merge
2d 41m
Merged PRs (30d)
15

Description

There is a lot of functionality in the scripts in the rapids-build-utils feature. It would be nice to have documentation of what this feature provides and how to use it.

The readme doesn't give much info.

https://github.com/rapidsai/devcontainers/blob/branch-23.12/features/src/rapids-build-utils/README.md

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with features/src/rapids-build-utils/README.md and inspect the scripts in the rapids-build-utils feature to inventory what it provides. Document the feature's functionality and how to use it; done means the README gives substantially more guidance than it currently does.

Written by the indexing model from the issue text.

Assessment

Tech stack
shell
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.