KEMBAR78
Contributing · shelljs/shelljs Wiki · GitHub
Skip to content
Nate Fischer edited this page Mar 19, 2025 · 4 revisions

We love contributions!

If you have any ideas for new features, find any bugs, or want to implement anything, please feel more than welcome to open a Github issue or open a pull request.

What makes a good feature?

  • Standard unix commands (available on both Linux and OS X preferably) that ShellJS is missing
  • Performance improvements
  • Making things behave more like POSIX

How can I get started?

Most commands run independently of each other, so this makes it pretty easy to contribute a new command. If you'd like to do this, just copy a command from src/ and use that as a template for your new command. Update the documentation (it's in a comment above the function declaration) and run node scripts/generate-docs.js to update the README. Lastly, write unit tests in the test/ folder (copy another file in that folder to use as a template).

Clone this wiki locally