linebender / linebender/bevy_vello

documentation buffs

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

Nobody has claimed this yet.

enhancement good first issue help wanted
Dominant language
Rust
Stars
298
Forks
31
Avg merge
5h 51m
Merged PRs (30d)
1

Description

Any documentation buffs welcome, since, ideally, we want to
```rs
#[deny(clippy::missing_docs)]
```

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 by inspecting the Rust repository for undocumented items and run the clippy missing-docs lint shown in the issue. Determine the documentation scope from the resulting warnings; done means the relevant missing documentation has been added and the lint passes.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.