Skip to content

Latest commit

 

History

History
100 lines (67 loc) · 3.12 KB

CONTRIBUTING.md

File metadata and controls

100 lines (67 loc) · 3.12 KB
Raw

Contributing

Introduction

Thank you for considering contributing to Etro! There are many ways you can contribute to Etro, like creating issues for features or bugs, improving the docs or wiki, or writing the code for the library. This page covers how to make changes to the repository files (either code or jsdocs).

Join our Discord

Setting up your local environment

Step 0: Dependencies

  • You will need Git, Node, NPM (at least 7.x) and Firefox (for headless functional testing) installed.

Step 1: Fork

  • Create your own fork of Etro. Then run

    git clone https://github.com/YOUR_USERNAME/etro.git
cd etro
npm install
npm test

Making your changes

Step 2: Code

  • Make some changes and update tests

  • If you are writing code, the linter uses StandardJS for style conventions

  • If you're adding or updating an effect:

    • Add your effect to scripts/gen-effect-samples.html
    • Run npm run effects
    • Briefly review the images in spec/integration/assets/effect/

  • When you're ready to submit, first run

    npm run lint
npm run build
npm test

    to lint the code, generate the dist files and run unit tests on them. It's helpful to put these commands in a pre-commit hook.

Step 3: Commit

  • Please follow these commit message guidelines:
    • Optionally, prefix each commit message with an appropriate emoji, such as :bug: for fixes.
    • Write in the imperative tense
    • Wrap lines after 72 characters (for Vim add filetype indent plugin on to ~/.vimrc, it's enabled by default in Atom).
    • Format: 
      :emoji: One-liner

Optional description

Submitting your changes

Step 4: Push

  • First, rebase (please avoid merging) to integrate your work with any new changes in the main repository

    git fetch upstream
git rebase upstream/master

  • Push to the fork

Step 5: Pull request

  • Open a pull request from the branch in your fork to the main repository
  • If you changed any core functionality, make sure you explain your motives for those changes

Step 6: Feedback

  • A large part of the submission process is receiving feedback on how you can improve you pull request. If you need to change your pull request, feel free to push more commits.

Code overview

Etro Overview

Check out the overview guide for an introduction to Etro.

Events

Events emitted by Etro objects use a pub/sub system. To emit an event, use event.publish(target, type, event). For instance,

event.publish(movie, 'movie.type.of.event', { additionalData: 'foo' })

That will notify all listeners of movie for event types 'movie', 'movie.type', 'movie.type.of' and 'movie.type.of.event'. To listen for an event, use event.subscribe(target, type, listener), like

event.subscribe(movie, 'movie.type', event => {
  console.log(event.target, event.type, event.additionalData) // should print the movie, 'movie.type.of.event', 'foo'
})