Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
60 lines (40 loc) · 1.14 KB

CONTRIBUTING.md

File metadata and controls

60 lines (40 loc) · 1.14 KB
Raw

CONTRIBUTING

Contributions are always welcome (and needed), no matter how big or small the contribution. Before contributing, please read the code of conduct.

Setup

  1. Install Eleven on your system: https://github.com/dysfunc/eleven
  2. Fork the repo: https://github.com/dysfunc/eleven
  3. Run the following commands:
$ git clone YOUR_ELEVEN_REPO_URL
$ cd eleven
$ yarn install

If you do not have yarn installed, run: $ npm install --global yarn

Development

$ gulp serve

Bundling

$ gulp build

Linting

$ gulp lint

Testing

$ gulp test

Pull Requests

We actively welcome your pull requests.

  1. Fork the repo and create your branch from master.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.

API Documentation

Use our API documentation to understand how to write plugins or extend Eleven's core functionality.

License

By contributing to Eleven, you agree that your contributions will be licensed under its BSD license.