n0-computer / n0-computer/net-tools

make `netwatcher`'s api more useful, better documented

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

Nobody has claimed this yet.

enhancement
Dominant language
Rust
Stars
29
Forks
36
Avg merge
1d 10h
Merged PRs (30d)
6

Description

netwatcher has a very small API that might not be as useful to the general public. It only gives a subscribe to changes that only reports if the change "is major" without any description of what being major is or the origin of the change. It would be good Providing a more detailed API and better docs.

Some inspiration: crates.io/crates/netwatcher

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 locating the netwatcher crate and reviewing its current subscribe-to-changes API and documentation. Compare its capabilities with the linked crates.io/netwatcher project, then define the additional change details, the meaning of a major change, and the documentation needed before implementation.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.