First of all, thank you! 😃 You have decided to contribute code to our software and become a member of the large Shopware community. We appreciate your hard work and want to handle it with the most possible respect.
To ensure the quality of our code and our products, we have created a list of guidelines for you. It helps you and us to collaborate with our software. Following these guidelines will help us integrate your changes into our daily workflow.
Requirements for a successful pull request
To avoid your pull request getting rejected, you should always check that you provided all the necessary information so that we can easily integrate your changes in our internal workflow. Here is a checklist of requirements you should always consider when committing new changes:
- A pull request to the Shopware core always has to be made to the platform repository.
- Fill out the pull request info template as detailed as possible.
- Create a changelog file with documentation of your changes. Refer to Changelog section for more detailed information about writing changelog.
- Check if your pull request addresses the correct Shopware version. Breaks and features can't be merged in a patch release.
- Check if your implementation is missing some important parts - For example, translations, downward compatibility, compatibility with important plugins, etc.
- Provide the necessary tests for your implementation.
- Check if there is already an existing pull request tackling the same issue.
- Write your commit messages in English, have them short and descriptive, and squash your commits meaningfully.
Pull requests which do not fulfill these requirements will never be accepted by our team. To avoid your changes going through unnecessary workflow cycles, make sure to check this list with every pull request.
The developing workflow on GitHub
When you create a new pull request on GitHub, it will normally get the first sight within a week. We do regular meetings to screen all new pull requests on GitHub. In this meeting, there is a team of Shopware developers of different specializations who will discuss your changes. Together we decide what will happen next to your pull request. We will set one of the following labels, which indicates the status of the pull request. Here is a list of all possible states:
|GitHub Label / Tag||What does it mean?|
|Your pull request is incomplete. It is either missing some of the necessary information, or your code implementation is not sufficient to fix the issue. Mostly there will be a comment by our developers which gives you further information about what is missing. Important: The label "Incomplete" means you have to take action. After your pull request has this label assigned, you have up to two weeks to update the pull request and provide the missing information or implementation. If there is no reaction from you within those two weeks, your pull request can be declined due to inactivity. This procedure ensures there are no orphaned pull requests in the backlog.|
|Your pull request was declined by our developers and is closed. We understand that it can sometimes be hard to understand the reason behind this. Mostly there will be a comment by our developers about why it was declined.|
|Your changes have been reviewed by our developers, and they decided that you provided a good benefit for our product. Your pull request will be imported to our ticket system and will go through our internal workflow. You will find a comment containing the ticket number to follow the status.|
|The changes you provide seem to be easy to test and implement. Our developers decided to integrate this quickly to our software. There will probably be no ticket for this change to follow, but you will be informed by the accepted label on this pull request that your change was finally merged into the product.|
|Your changes are finally accepted. The pull request passed our internal workflow. Your changes will be released with one of the next releases.|
|Your pull request includes a new feature that needs an internal discussion by our developers. We have to decide if the new feature provides a good benefit for the product and at which point it should be scheduled on the roadmap.|
|Your pull request includes a larger refactoring which needs an internal discussion by our developers. This label will mainly be set when larger chunks of code have been re-written, renamed, or moved to different directories.|
|Your pull request lacks the necessary tests for your changes. E.g. Jest or Cypress tests for frontend changes or PHPUnit tests for backend changes.|
Why a pull request gets declined
So the worst thing happened; Your pull request was declined. No reason to be upset. We know that it can sometimes be hard to understand why your pull request was rejected. We want to be as transparent as possible, but sometimes it can also rely on internal decisions.
Here is a list of common reasons why we reject a pull request:
- The pull request does not fulfill the requirements of the list above.
- You did not update your pull request with the necessary info after a specific label was added.
- The change you made is already a part of a current change by Shopware and is handled internally.
- The benefit of your change is not relevant to the whole product but only to your personal intent.
- The benefit of your change is too minor. Sometimes we do not have enough resources to handle every small change.
- Your change implements a feature that does not fit our roadmap or our company values.