Skip to content
This repository has been archived by the owner on Apr 19, 2024. It is now read-only.

Latest commit

 

History

History
39 lines (23 loc) · 2.07 KB

index.md

File metadata and controls

39 lines (23 loc) · 2.07 KB
title section
Contributing
contributing

General guidelines

Spree is an open, community-powered project that anyone can contribute to. There are several ways you can help us improve Spree:

  • submitting an issue describing a bug or a feature request
  • fixing a bug or creating a new feature
  • creating a Spree extension
  • upgrading old extensions to recent Spree versions
  • helping others on Spree slack

Submitting issues

You can submit an issue on our Github Issues tracker

Fixing a bug or creating a new feature

Before diving into the Spree codebase we recommend you spend some time reviewing the Internals section which will help you understand how Spree works under the hood.

After you're done with that please follow to Developing Spree guide

To find issues you can tackle on we recommend visiting Spree Contribute page which lists issues tagged with Good First Issue label. Those bugs or features are great starting points into Open Source development.

Creating a Spree extension

Extensions provide additional features and integrations for your Spree store. You can create your own and share with the rest of the community. Before doing so please check our Extension directory if your desired extension does not exist already. If not follow Extensions tutorial to learn how to create one.

Upgrading old extensions to recent Spree versions

If you found an extension that does not work with the current Spree version you can read the Updating Extensions for Spree guide to bring it up to speed.

Helping others on Spree slack

Last but not least, you're invited to join our slack to help and receive guidance from fellow Spree developers including Spree Core Team.