Skip to content
Nate Fischer edited this page Apr 6, 2016 · 3 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).

Roadmap

Similar rules to how dthree/cash does its roadmap. Feel free to add any missing commands, or put a 👍 after a command you'd like to vote for.

  • hostname()
  • sed() (more options)
  • uniq()
  • curl()
  • clear()
  • sleep()