Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
If you are reporting a bug, or adding/changing a feature, providing a test case will go a long way towards getting your change merged or issue fixed.
Unfortunately, if you just drop a code sample in the Github issue/Gist, that doesn't provide us with a failing test. Someone will have to write that test, before working on the fix/change.
The process is standard fair:
- Fork and clone
npm install
npm test
- Write your test(s)
- Any code changes you want to add
git push
- Submit a pull request
If you're making a documentation change, Github allows you to edit README.md
directly from the web
page and will handle
forking and pull request for you.
Zombie uses ESLint for linting and enforcing coding style.
It is written with ES7/2016, so we can use all the fancy new ES6 language
features
and async/await
.
The project includes .eslintrc
files and the ESLint/Babel.js dependencies.
You can check here to learn
how to use ESLint with just about any text editor.
The documentation is written in Github-flavored Markdown.