haskell-distributed / haskell-distributed/distributed-process

Carefully document semantics.

Open
#407 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement network-transport
Dominant language
Haskell
Stars
751
Forks
99
Avg merge
45m
Merged PRs (30d)
2

Description

We need to carefully document network-transport semanitics covering all events that should/must and may happen when some action have happened.

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 by locating the network-transport event definitions and any existing documentation in the repository. Document which events should, must, or may occur after each relevant action; the work is done when all event semantics are covered clearly.

Written by the indexing model from the issue text.

Assessment

Tech stack
haskell
Domain
distributed-systems, documentation
Issue type
Documentation
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.