Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
M0rgan01 authored and Morgan Pichat committed Oct 18, 2024
1 parent 39439ea commit 12a8e21
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 7 deletions.
4 changes: 3 additions & 1 deletion contribute/contribution-guidelines/pull-requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ If no issue is linked to your Pull Request, maintainers might ask you to create

This field should contain links to related PRs in other repositories.

If your Pull Request modifies database structure or adds new configuration fields, you should also provide a PR for [autoupgrade module](https://github.com/PrestaShop/autoupgrade).
If your Pull Request modifies the database structure, adds new configuration fields, or is automatically assigned with the “Needs Autoupgrade PR” label, you must create a corresponding PR for the Autoupgrade module. For more information on this process, see Contributions to the [Autoupgrade module][1].

If your Pull Request needs a theme change to work, you should provide [hummingbird](https://github.com/PrestaShop/hummingbird) and [classic-theme](https://github.com/PrestaShop/classic-theme) PR.

Expand All @@ -149,3 +149,5 @@ Including automated tests (unit, integration or functional) that verify your cha
### Possible impacts

PrestaShop's QA team will not only verify the right behavior of your change but also verify that other related parts of the software are still working as expected. For example modifying a CSS class can disrupt the display of all the web pages which rely on it. Please mention all the impacts you are aware of that need to be checked in order to help QA team find and verify all of them.

[1]: {{< relref "/9/contribute/contribution-guidelines/upgrade-module" >}}
10 changes: 4 additions & 6 deletions contribute/contribution-guidelines/upgrade-module.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Upgrade Contributions
title: Contributions to the Autoupgrade module
weight: 60
---

Expand All @@ -17,15 +17,14 @@ It is essential to keep the upgrade process up to date according to the changes

## How to determine which content is affected and what needs to be added ?

When there's a modification to the `db-structure.sql` file or if a Doctrine entity has been modified, added, or deleted, it impacts the database structure. Modifying the list of hooks and feature flags has consequences on the upgrade process as well.
When there's a modification to the `db-structure.sql` file or if a Doctrine entity has been modified, added, or deleted, it impacts the database structure. Modifying the list of hooks, feature flags, new configurations (or generally new base fixtures) has consequences on the upgrade process as well.

These changes can affect how the application interacts with the database and how upgrade procedures are handled.

It's important to consider these aspects when contributing to ensure a smooth upgrade experience for users.

{{% notice tip %}}
The Core command prestashop:schema:update-without-foreign allows you to update the database according to modifications made to the Doctrine entities during the development phase. It outputs the queries executed for each change detected.
Please note, after restarting the command the requests will have already been executed and the output will be empty.
The core command `prestashop:schema:update-without-foreign --dump-sql` allows you to retrieve the queries needed to update the database according to changes made to the Doctrine entities.

It is also possible to retrieve a diff of SQL dumps made in the summary of the GitHub actions `Check the label 'Needs autoupgrade PR'` if the label was added automatically.
{{% /notice %}}
Expand All @@ -34,8 +33,7 @@ It is also possible to retrieve a diff of SQL dumps made in the summary of the G

Also known as the “1-click upgrade module”, the autoupgrade module is responsible for running the upgrade process on PrestaShop stores. This is likely where upgrade migration files must be added where the pull-request is labeled with 'Needs autoupgrade PR'.

Contributions related to the upgrade process should be targeted towards the [Autoupgrade repository](https://github.com/PrestaShop/autoupgrade).

Contributions related to the upgrade process should be targeted towards the [Autoupgrade repository](https://github.com/PrestaShop/autoupgrade), and more specifically in one of these [upgrade scripts](https://github.com/PrestaShop/autoupgrade/tree/dev/upgrade/sql).
Reading the Project Modules section will explain the basics of contributing to the [PrestaShop module][1]

## Changes related to modules
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,10 @@ If something is wrong, Prestonbot will write a comment in the pull request to te

Issuebot (based on the [probot framework](https://github.com/probot/probot)) is another bot that automates our issue/PR workflow. It will make sure your Pull Request metadata, such as labels or Kanban cards, are valid.

### “Needs Autoupgrade PR” automated label

If your Pull Request modifies the database structure, adds new configuration fields, or is automatically assigned with the “Needs Autoupgrade PR” label, you must create a corresponding PR for the Autoupgrade module. For more information on this process, see Contributions to the [Autoupgrade module][1].

## The code review

Your Pull Request will be reviewed by a Core maintainer.
Expand Down Expand Up @@ -84,3 +88,5 @@ After the Pull Request has finally passed the QA validation, it is merged in the
---

_(This article was originally published on our blog: [What Happens To Pull Requests After They Are Submitted](https://build.prestashop-project.org/news/the-review-process/))_

[1]: {{< relref "/9/contribute/contribution-guidelines/upgrade-module" >}}

0 comments on commit 12a8e21

Please sign in to comment.