oven-sh/bun

Documentation and Accessibility

Open

#2,467 opened on Mar 23, 2023

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Rust (4,486 forks)batch import
docsgood first issue

Repository metrics

Stars
 (90,348 stars)
PR merge metrics
 (Avg merge 1d 17h) (357 merged PRs in 30d)

Description

What is the type of issue?

Something else

What is the issue?

There're a few things that I was trying to do:

  • Building from source
  • Understand how does Bun works
  • Contribute to good first issue issues
  • Etc

Basically facing difficulties to participate in this OSS.

Where did you find it?

I feel like:

  • Building Docs needs more cases on how to build in any OS, the docs only focus on MacOS
  • I think would be nice to add a section explaining Bun’s current source code “architecture”, e.g:
    • What connects to What
    • Why do we need X, why do we need Y.
    • Etc.

Contributor guide

Research direction
Identify missing build instructions for various operating systems and create a guide. Additionally, document the high level architecture of Bun's source code to aid understanding.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90