Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update code-contribution-guide.md #2569

Merged
merged 3 commits into from
Mar 15, 2024
Merged

Update code-contribution-guide.md #2569

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f029113
Update code-contribution-guide.md
andriispryker Mar 15, 2024
48225fe
Merge branch 'master' into andriispryker-patch-1
andriitserkovnyi Mar 15, 2024
d30dd8c
Update code-contribution-guide.md
andriitserkovnyi Mar 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 19 additions & 30 deletions docs/dg/dev/code-contribution-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,52 +1,41 @@
---
title: Code contribution guide
description: Contribute into Spryker Commerce OS.
last_updated: Jun 16, 2021
description: Contribute into Spryker repositories
last_updated: Mar 15, 2024
template: concept-topic-template
originalLink: https://documentation.spryker.com/2021080/docs/code-contribution-guide
originalArticleId: d5ded6f2-5bb9-4288-bc96-3fabf7e32c8f
redirect_from:
- /docs/scos/dev/code-contribution-guide.html
---
related:
- title: Contribute to the documentation
link: docs/scos/user/intro-to-spryker/contribute-to-the-documentation/contribute-to-the-documentation.html

{% info_block infoBox %}
We are currently revising our code contribution concept and will update this page once the new concept is finalised. Please note that while we are working on the new concept we will unfortunately not be able to consider external contributions to our code base.
{% endinfo_block %}
---

In Spryker, we welcome contributions in all forms, be it detailed Issues or Pull Requests (PRs). As PRs directly show the changes and the context, we verify and ship them faster. Therefore, *PRs are the preferred method of contribution*.
We welcome all types of contributions, from issues to PRs. Because PRs reflect the changes and the context, we verify and ship them faster. Therefore, *PRs are the preferred method of contribution*.


## Licenses

Spryker uses different licenses: our proprietary licenses and common open-source licenses. In general, you can contribute to our public repositories
Spryker uses our proprietary licenses and common open-source licenses. In general, you can contribute to our public repositories:

- [spryker](https://github.com/spryker)
- [spryker-shop](https://github.com/spryker-shop)
- [spryker-eco](https://github.com/spryker-eco)
- [spryker-sdk](https://github.com/spryker-sdk)
- [spryker-middleware](https://github.com/spryker-middleware)

Read `CONTRIBUTING.md` of a module before opening a PR.

## Opening pull requests
## Submit a PR

To contribute to a Spryker repository, follow these steps:
1. Fork the repository and create a branch with your changes. Ensure that the commit messages explain the aim of the applied changes or fixes.
2. Open a PR in the repository. Ensure that the title and description clearly describe the context of your work.
3. Create a Support Case in (https://spryker.force.com/support/s/) and link your pull request inside it.
1. Fork the repository and create a branch.
2. Add and commit your changes.
Make sure the commit description clearly reflects the changes.
2. Create a PR.
Make sure the PR name and description clearly reflect the context and the changes.

If we cannot merge a PR due to our release process, we manually introduce the change. Once the change is released, we inform you by closing the PR. We also provide the link to the relevant release or releases so you can check your changes. Issue integration process is shown in the following diagram.
If we can't merge a PR due to our release process, we manually introduce the change. Once the change is released, we inform you by closing the PR.

For most Spryker and SprykerShop modules we need a special process since those are developed in a mono-repo:
<div style="text-align:center;"><img src="https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Code+Contribution+Guide/code-contirubtion.png" alt="code-contirubtion.png"></div>

## PR processing time

## When will you process my request?

The processing time depends on the importance of the changes and the amount of work required to check and implement the changes. In case an important change is requested via a PR, we may be able to ship it within one day.

If you create a PR and feel that the issue is important, [contact our support](https://spryker.force.com/support/s/) to speed up the process.

---
**See also:**
The processing time depends on the importance of the changes and the amount of work required to check and implement them. If an important change is submitted, we usually process it within a day.

[Contribute to documentation](/docs/scos/user/intro-to-spryker/contribute-to-the-documentation/contribute-to-the-documentation.html)
If you create a PR and feel that the issue is important, [contact support](https://spryker.force.com/support/s/) to speed up the process.
Loading