theupdateframework / theupdateframework/rust-tuf

Add contributing/style guide

Open
#74 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Priority :: Low
Dominant language
Rust
Stars
198
Forks
39
Avg merge
9h 19m
Merged PRs (30d)
2

Description

Even just to keep myself organized. Off the top of my head, it should include things like what to log and at what level to log it.

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

The issue names no files, tests, or entry points. Start by locating the repository's existing contributor documentation and logging guidance, then document contribution and style expectations, including what to log and which levels to use; done means the guide is clear and committed in the appropriate documentation location.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.