trekhleb / trekhleb/javascript-algorithms

More detailed instructions on how to run the code for beginners

Open
#546 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
197k
Forks
31k
PR merge metrics
No merged PRs in 30d

Description

Hi

I think there should a sample snippet in playground.js to show how to run the scripts.

i am running it like this

// Place your playground code here.

import BubbleSort from "../algorithms/sorting/bubble-sort/BubbleSort"

const b = new BubbleSort()
const r = b.sort([99, 9, 999])
console.log(r)

&

node --es-module-specifier-resolution=node playground/playground.js

my node version v14.12.0

Pls, let me if this is the right way to test out the scripts in playgroud.

If yes I would also like to update the README.md to mention the same.

Pls let me know your thoughts

Thanks

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 with playground/playground.js and README.md, then run the example command with the documented Node.js version. Confirm how the playground scripts are intended to be run and document the sample snippet and command in README.md so beginners can reproduce the result.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.