CONTRIBUTING.md

Contributing

Current list of Contributors.

Code Of Conduct

By participating in this project you agree to our Code of Conduct.

Issues

Current issue tracker is on GitHub.

Even if you are uncomfortable with code, an issue or question is welcome.

Note: If you are reporting a bug or feature request for vile.io itself, please see forthright/vile.io instead.

Patches

All you need to do is submit a Pull Request.

1. Please consider tests and code quality before submitting.
2. Please try to keep commits clean, atomic and well explained (for others).

Note: If you prefer to submit a patch then please open an issue and link to it.

Developing

Vile is centered around the use of plugins that generate issues.

A plugin can be written in JavaScript, or easily shell out to another language.

The core library and cli is written in TypeScript.

Test code is written in CoffeeScript.

Getting Started

Clone the repos:

git clone git@github.com:forthright/vile.git
git clone git@github.com:forthright/vile-docs.git
cd vile

Install packages:

npm i

See all available build commands:

npm run

Compile from src to lib:

npm run -s compile

To run the CLI locally:

node bin/vile -h

To run tests:

npm -s t

To run without system level tests:

npm run -s test-fast

To run with system level tests:

npm run -s test-sys

And to run with test coverage:

npm run -s test-cov

To run compile task with file watch in the background:

npm run dev

To generate latest docs:

npm run -s gen-docs
[browser] ../vile-docs/public/index.html