Skip to content

Commit

Permalink
Update contribution.md (#1237)
Browse files Browse the repository at this point in the history 
Fix links, grammar tweaks
  • Loading branch information
@DaxServer
DaxServer authored Dec 18, 2023
1 parent 76c59d6 commit 13cab6d
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions resources/guidelines/code/contribution.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ To ensure the quality of our code and our products, we have created a list of gu

## 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:
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 into 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](https://github.com/shopware/shopware) repository.
* Fill out the [pull request info template](https://github.com/shopware/shopware/blob/master/.github/PULL_REQUEST_TEMPLATE.md) as detailed as possible.
* A pull request to the Shopware core always has to be made to the [main shopware](https://github.com/shopware/shopware) repository.
* Fill out the [pull request info template](https://github.com/shopware/shopware/blob/trunk/.github/PULL_REQUEST_TEMPLATE.md) as detailed as possible.
* Create a changelog file with documentation of your changes. Refer to [Changelog](https://github.com/shopware/shopware/blob/master/adr/2020-08-03-implement-new-changelog.md) 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.
Expand All @@ -39,10 +39,10 @@ When you create a new pull request on GitHub, it will normally get the first sig
|:------------------------------------------------------------------------------------:| :--- |
| ![GitHub label incomplete](../../../assets/github-label-incomplete.png) | 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. |
| ![GitHub label declined](../../../assets/github-label-declined.png) | 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. |
| ![GitHub label scheduled](../../../assets/github-label-scheduled.png) | 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. |
| ![GitHub label quickpick](../../../assets/github-label-quickpick.png) | 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. |
| ![GitHub label scheduled](../../../assets/github-label-scheduled.png) | Your changes have been reviewed by our developers, and they decided that you provided a benefit for our product. Your pull request will be imported into our ticket system and will go through our internal workflow. You will find a comment containing the ticket number to follow the status. |
| ![GitHub label quickpick](../../../assets/github-label-quickpick.png) | The changes you provide seem to be easy to test and implement. Our developers decided to integrate this quickly into 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. |
| ![GitHub label accepted](../../../assets/github-label-accepted.png) | Your changes are finally accepted. The pull request passed our internal workflow. Your changes will be released with one of the next releases. |
| ![GitHub label feature request](../../../assets/github-label-feature.png) | 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. |
| ![GitHub label feature request](../../../assets/github-label-feature.png) | 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 benefit for the product and at which point it should be scheduled on the roadmap. |
| ![GitHub label refactoring](../../../assets/github-label-refactoring.png) | 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. |
| ![GitHub label missing tests](../../../assets/github-label-missing-tests.png) | Your pull request lacks the necessary tests for your changes. E.g. [Jest](../../../guides/plugins/plugins/testing/jest-admin) or [Cypress](../../../guides/plugins/plugins/testing/end-to-end-testing) tests for frontend changes or [PHPUnit](../../../guides/plugins/plugins/testing/php-unit) tests for backend changes. |

Expand All @@ -55,6 +55,6 @@ 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 not relevant to the whole product but only to your 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.

0 comments on commit 13cab6d

Please sign in to comment.