Contributing

Contributing

We welcome contributions! Here's how you can help.

Development Setup

git clone https://github.com/jstility/tship.git
cd tship
npm install
npm run build
npm link

Running Tests

npm test

Documentation

The documentation site lives in /docs. To work on it locally:

cd docs
npm install
npm run dev

Pull Requests

  1. Fork the repo
  2. Create a feature branch
  3. Make your changes
  4. Add tests if applicable
  5. Submit a PR with a clear description