Making Contributions

Syncing

This issue arises when the master branch of the upstream repository has been changed (i.e. new commits added) since you checked out a development branch. It can be resolved in the following manner -

0. Click on the command line instructions as shown in the image above. The instructions are also explained below.
1. Navigate to the current working directory of your working project on the command line.
2. Run git remote to determine the remote name, if you have multiple remotes configured, you can run git remote -v to also see the URLs associated with each remote. The remote you want will have a URL containing github.com/zen-audio-player/zen-audio-player.github.io.
3. Use git fetch upstream to fetch the branches and their respective commits from the upstream repository and store them locally. Commits to the upstream master branch are stored in a local branch upstream/master.
4. Check out your branch using git checkout <your-branchname>.
5. Merge the changes from upstream/master into your branch using git merge upstream/master. This syncs your branch with the upstream repository, without losing your local changes.
6. Now you can again push your local changes using git push origin <your-branchname>.

Issues & Bug Reports

If you're seeing some unexpected behavior, please create an issue on GitHub with the following information:

0. A screenshot
1. Browser, browser version, and operating system
2. The expected behavior, actual behavior, and steps to reproduce it
3. Possible solution, fix, or workaround

If you create an issue for a change, improvement, or feature request:

0. Give a description of the problem you're trying to solve, and why.
1. If the feature changes current behavior, explain why your solution is better.

Pull Requests

Before making a pull request:

0. Read the CONTRIBUTING guidelines - specifically, the steps dealing with pull requests.
1. Make sure your code follows the code style of this project and passed all tests.
2. Update the documentation to reflect your changes.

When making a pull request, describe your changes in detail. Include the following information:

Motivation and Context

• Why is this change required? What problem does it solve?
• If it fixes an open issue, include the text Closes #1 (where 1 would be the issue number) to your commit message.

Types of changes

What types of changes does your code introduce?

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)