Skip to content

Contributing

Jump to bottom
Alexander Frick edited this page Mar 28, 2023 · 1 revision

Contributing to Apple Music Electron

Firstly, Thanks for supporting AME.

By contributing to Apple-Music-Electron you are agreeing to our Code of Conduct, and any breach made to the Code of Conduct will result in the Enforcement Guidelines being put into effect.

Best Practices

All languages are accepted, however it's best to use English in PRs/Issues as translation is not always the best. If you contribute in any form to this application in a non-English language, if translation cannot be done your contribution may be discarded.

Issues

  • Issues are created here.
  • Stick to the templates provided, if you fail to do so the issue will be ignored.
  • Please check pinned / old issues before opening an issue.

Issue Closure

  • Bug reports will be closed if the issue has been inactive and the latest affected version no longer receives support. At the moment, we only maintain the most recent release, we each concurrent release improving in the previous version.

If you feel that your issue should be a higher priority or should not have been closed, feel free to mention one of the developers with a reason why, and it will potentially be raised.

Pull Requests

Pull Requests are done to help keep our application upto date, as well as being a method for you to help build on the application. In order for your Pull Request to be accepted it must:

  • Be upto date with the master branch
  • Not break or collide with any existing features
  • Work correctly on all platforms
  • Your code is thoroughly tested for regression.

How to create themes for Apple Music Electron

Guide on Creating Themes

Themes are very straightforward, if you have any knowledge in CSS you will find this process easy. Just find your application path using this FAQ.

In this directory, you can find all the information you need. If you go into the themes directory, you can find all the themes that are currently downloaded on your installation, these are all cloned from here everytime you check the overwriteThemes in the advanced category in the settings. If you are developing themes, do not check this as it will wipe your themes directory.

Use the Template.css file in that directory and the existing themes to design your own. Once you've created the file and have defined the base metadata:

/*
 * @name ThemeName
 * @author YouName (GitHub Link)
 * @description A good description
*/

If you restart the app, the theme name should appear in the themes list found in the visual category, select it and restart and your theme will be applied.

Requirements for Merging

If you wish to get your theme on the main repository for the application, you will need to complete the following in order for it to be accepted.

  • Provide metadata tags with correct information with a clear description.
  • Provide support for any transparency (Using --transparency)
  • Provide clear support for light/dark mode (I.e. using prefers-color-scheme:dark). Ideally, we would like support for both light and dark mode.
  • Provide a good-looking theme.
  • The theme should work correctly on any hardware and should not be dependent on any modules and/or elements of an operating system.
  • The theme should not be plagiarized or copied without crediting the author.
  • Have screenshots of the theme provided in the Pull Request.

Once you are done open a Pull Request.

If you have any further additions that you wish to add to the application that are not themes, take a look at our contributing guide.

How to create plugins for Apple Music Electron

Guide on Creating Plugins

(Coming Soon)

Clone this wiki locally