Community involvement is essential to the success of El.js and the rest of the Hanzo ecosystem. To make changes and get them into the library, here are some guidelines to make that process smooth for all involved.
To report a bug, request a feature, or even ask a question, make use of the GitHub Issues section for El.js. When submitting an issue please take the following steps:
-
Seach for existing issues. Your question or bug may have already been answered or fixed, be sure to search the issues first before putting in a duplicate issue.
-
Create an isolated and reproducible test case. If you are reporting a bug, make sure you also have a minimal, runnable, code example that reproduces the problem you have.
-
Include a live example. After narrowing your code down to only the problem areas, make use of jsFiddle, jsBin, or a link to your live site so that we can view a live example of the problem.
-
Share as much information as possible. Include browser version affected, your OS, version of the library, steps to reproduce, etc. "X isn't working!!!1!" will probably just be closed.
To make changes you will need to take a few steps, which we've outlined below:
-
Ensure you have Node.js installed. You can download Node.js from nodejs.org. Because El.js uses modern JS features, you will need a modern version of Node. v7+ is recommended.
-
Fork the El.js repository, if you are unsure how to do this GitHub has a guides for the command line and for the GitHub Client.
-
Next, run
npm installfrom within your clone of your fork. That will install dependencies necessary to build El.js.
Your change should be made directly to the branch in your fork, or to a branch in your fork made off of master.
After you have made and tested your change, commit and push it to your fork. Then, open a Pull Request from your fork to the main El.js repository.
- Use 2 spaces for tabs, never tab characters.
- No trailing whitespace, blank lines should have no whitespace.