Skip to content

Contributions

Nam Anh edited this page Jun 21, 2022 · 8 revisions

We welcome all contributions of any kind in the hopes of making Marketplace the go-to place for Spicetify users!
This serves as a navigation page for you to go around the repository and get what you need.

Issues

Before making an issue, it is important that you:

This helps organize the repository and makes it as efficient as possible for us to work on your requests ❤️.

Templates

Once you have done all of the above, these templates will help us sort your request based on how important & emergent they are:

  • To report errors, bugs and unexpected behaviors that you encounter while using Marketplace refer to the 🐛 Bug report template.
  • To suggest features and enhancements that you think would be awesome to have in Marketplace head to the ✨ Feature Request template.
  • To report malicious creations that you think is invasive, breaking, or making your client unusable go to the 🦠 Malicious extension report template.

We will try our best to look into each & every one of them, so you needn't worry if you haven't heard from us in a while.

Pull requests

Of course, we are not able to work on Marketplace full-time or have the most effective methods from time to time, so if you are confident and are able to claim the task, feel free to make your own Pull Request!

But there are some caveats that comes with it that we will require you to fulfill before your contribution is published in the latest Marketplace build. Just minor ones, don't worry!

Head to Development to get started!

Workflow check

Though only a few checks available, workflow checks allows us to see if there are any breaking changes to Marketplace, at the same time keep the source code readable & easily maintained.

There are 2 checks that are required to pass before a PR is merged:

  • build check: This workflow check helps us determine if your fork of Marketplace can be compiled and published. It runs by executing yarn build:local as an attempt to compile the code beforehand.
  • lint check: Though not related to the build & execution process, this check helps us keep Marketplace source code organized, readable, easily understood and maintained using a fixed set of rules customized for this repository.

image

Feel free to mention the repository maintainers (@CharlieS1103, @theRealPadster, and @kyrie25) for help with your PR, or just chat with us on our Discord server!

Clone this wiki locally