mafintosh / mafintosh/pbs

Format documentation

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

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
68
Forks
5
PR merge metrics
No merged PRs in 30d

Description

It would help to understand how PBS streams are structured. This can be read from source but having this available in the documentation would be really helpful!

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 reading the source to determine how PBS streams are structured and which stream details are important to explain. Document that structure in the repository's documentation, with enough detail for users to understand it; no specific documentation file or test is named in the issue.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.