Contributing Guidelines

Contact

Join the chat room on Gitter

Fork the repo!
Clone your fork of the repo: git clone git@github.com:<YOUR-USERNAME>/zen-audio-player.github.io.git.
Navigate to the project: cd zen-audio-player.github.io.
Install test dependencies: npm install.
If you've started working on an issue, leave a comment as it helps avoid duplicate work.
Create a branch(whose name reflect the issue you are working on) and make your changes.
Run the tests: npm test.
Run git commit and add your message describing what you have changed. If you have made changes that address an issue include the text Closes #1 (where 1 would be the issue number) to your commit message.
Submit a pull request - Travis CI will run tests to make sure nothing broke. Once you have committed your changes locally and pushed them to your fork of the repo, a banner with a Compare & pull request button should appear on the main Zen Audio Player repo page to submit a pull request. The base fork is this repo, and the base is master. The head fork is your clone of the repo, and under compare, choose the branch that you created in step 6.
In case the following occurs, visit the Syncing section of our Wiki pages.
After you've had 1 PR merged, @shakeelmohamed will add you to the organization. Then you can create any issues you work on before you start.
For more information on contributions, please visit the Making Contributions section of our Wiki pages