rapidsai / rapidsai/docs

[FEA] Standardized code building information in contributing

Open
#504 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

? - Needs Triage feature request
Dominant language
HTML
Stars
52
Forks
73
Avg merge
4d 16m
Merged PRs (30d)
8

Description

Is your feature request related to a problem? Please describe.
Raised https://github.com/rapidsai/cudf/issues/15395 and @vyasr thought it could be discussed at a RAPIDS level. I thought it would create an issue here.

Describe the solution you'd like
The contributing page has a section on building code using https://github.com/rapidsai/devcontainers

Describe alternatives you've considered
If there are differences between the libraries the contributing page you could have a table that has each project in a row and a link to it's contributing page.

Additional context
See above.

Contributor guide

Open the contributing guide

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 the contributing page and review the RAPIDS devcontainers project linked in the issue. Compare the relevant contributing pages across RAPIDS libraries, then document a consistent code-building section or a table of project-specific links. Done means the contributing guidance is standardized and clearly links any library-specific instructions.

Written by the indexing model from the issue text.

Assessment

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.