8000 Os project page improvements by kpodemski · Pull Request #288 · PrestaShop/open-source · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Os project page improvements #288

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.

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

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion content/get-involved/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ More information: [How to contribute (DevDocs)][how-to-contribute]
[report-bug]: {{< relref "report-issues" >}}
[request-feature]: {{< relref "request-features" >}}
[review-code]: {{< relref "/maintainers-guide/processes/reviewing-pull-requests.md" >}}
[test-code]: {{< relref "/project-organization/quality-council/processes/test-pr-and-branches/" >}}
[test-code]: {{< relref "/project-organization/quality-council/processes/pr-management/#how-to-test-a-pr-manually" >}}
[issue-gardening]: {{< relref "/project-organization/quality-council/processes/issue-management/" >}}
[slack]: {{< relref "/slack/" >}}
[github]: https://github.com/PrestaShop/PrestaShop/
Expand Down
2 changes: 1 addition & 1 deletion content/get-involved/report-issues/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ To create your first issue, go to the [list of issues](https://github.com/Presta

On the next screen, choose "Bug report" and click on "Get started"

<img src="img/github-select-issue-type.png" alt="Choose Bug report" class="mx-lg-4" style="max-width: 700px">
<img src="img/github-select-issue-type.jpeg" alt="Choose Bug report" class="mx-lg-4" style="max-width: 700px">

Now fill out the form and click the "Submit new issue" button when you are done.

Expand Down
11 changes: 6 additions & 5 deletions content/get-involved/request-features/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,24 @@ title: How to use GitHub to suggest a feature

# How to use GitHub to suggest a feature

PrestaShop uses GitHub issues to track bugs and feature requests. This is the best place to suggest ideas to improve the software.
PrestaShop uses GitHub issues to track bugs. For feature requests, we use GitHub discussions. This is where you can suggest new features, improvements, or changes to existing features.
All users can also vote for the features they like the most.

{{% notice tip %}}
You need a free GitHub account to collaborate. If you don't have one yet, you can [create it here](https://github.com/join).
{{% /notice %}}

## Creating a feature request

To create a feature request, go to the [list of issues](https://github.com/PrestaShop/PrestaShop/issues) and click on the "New issue" button on the right. Or just [click here](https://github.com/PrestaShop/PrestaShop/issues/new/choose).
To create a feature request, you can go to the [list of issues](https://github.com/PrestaShop/PrestaShop/issues) and click on the "New issue" button on the right. Or just [click here](https://github.com/PrestaShop/PrestaShop/issues/new/choose).

<img src="img/github-new-issue.png" alt="Click on the New issue button" class="mx-lg-4" style="max-width: 700px">

On the next screen, choose "Feature request", and click on "Get started"
On the next screen, choose "Idea / Feature request", you will be redirected to the form to fill out to create a new discussion.

<img src="img/github-select-issue-type.png" alt="Choose Bug report" class="mx-lg-4" style="max-width: 700px">
<img src="img/github-select-issue-type.jpeg" alt="Choose Bug report" class="mx-lg-4" style="max-width: 700px">

Now fill out the form and click the "Submit new issue" button when you are done.
Now fill out the form and click the "Start discussion" button when you are done.

{{% notice tip %}}
GitHub provides very good documentation about how to write [issues](https://guides.github.com/features/issues/) with its [flavoured Markdown](https://github.github.com/gfm/). It is possible to [highlight code syntax](https://help.github.com/articles/creating-and-highlighting-code-blocks/), [add pictures](https://help.github.com/articles/file-attachments-on-issues-and-pull-requests/), or even to [link issues and pull requests](https://help.github.com/articles/autolinked-references-and-urls/).
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
17 changes: 10 additions & 7 deletions content/maintainers-guide/processes/reviewing-pull-requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ label[type=needsdoc] { background-color: #D93E0B; color: #fff; }
label[type=needsupgrade] { background-color: #D93E0B; color: #fff; }
label[type=needstheme] { background-color: #D93E0B; color: #fff; }
label[type=wip] { background-color: #FF8800; }
label[type=e2e] { background-color: #EDEDED; }
label[type=e2e], label[type=targetedcontributions] { background-color: #EDEDED; }
label[type=migration] { background-color: #00E031; }
</style>

Expand Down Expand Up @@ -134,7 +134,7 @@ A Pull Request may only be merged after the following requirements have been ful
- The change does not have any outstanding merge conflicts.
- Automated checks (including automated tests) are passing.

On the [PrestaShop Core repository][prestashop-core-repository]), two approvals are required.
On the [PrestaShop Core repository][prestashop-core-repository], two approvals are required.

### After merging

Expand All @@ -144,7 +144,7 @@ After merging a Pull Request on the Core Repository, maintainers must make sure
- Add the label <label type="keyfeature">Key feature</label> if the Pull Request must be mentioned in the Release Note.
- Add the label <label type="bcbreak">BC break</label> if the Pull Request introduces a [BC Break][bc-break].
- Add the label <label type="needsdoc">Needs documentation</label> if the Pull Request introduces changes that need to be documented in [DevDocs][dev-doc].
- Add the label <label type="needsupgrade">Needs autoupgrade PR</label> if the Pull Request introduces changes in configuration or data structure and existing installs need to be modified.
- Add the label <label type="needsupgrade">Needs autoupgrade PR</label> if the Pull Request introduces changes in configuration or data structure and existing installs need to be modified. This label may be created automatically.
- Add the label <label type="needstheme">Needs theme PR</label> if the Pull Request introduces changes that need theme modification to work.

These actions are very important as they will be key to writing a good Release Note and ChangeLog for the next version.
Expand All @@ -163,7 +163,7 @@ Example of such Pull Requests:
- Thank the Pull Request author and anybody else who invested notable energy into the Pull Request (code review, code suggestions, QA validation, usecase specification ...).


![Thank you message](../images/thank-you.png)
![Thank you message](../../images/thank-you.png)

## Labeling reference

Expand All @@ -187,7 +187,7 @@ The following labels are added when an action is required:
| The PR introduced wording changes | Wording Managers | <label type="needs">Waiting for Wording</label> | <label type="check">Wording ✓</label> |
| The PR is ready for QA verification | Software Testers | <label type="needs">Waiting for QA</label> | <label type="check">QA ✓</label> |
| The PR needs to be documented in DevDocs | Maintainers | <label type="needsdoc">Needs documentation</label> | <label type="check">Documentation ✓</label> |
| The PR needs PR for autoupgrade module | The PR's author | <label type="needsupgrade">Needs autoupgrade PR</label> | _(no label)_ |
| The PR needs PR for autoupgrade module | The PR's author | <label type="needsupgrade">Needs autoupgrade PR</label> | <label type="check">PR Autoupgrade opened ✓</label> |
| The PR needs PR for default theme | The PR's author | <label type="needstheme">Needs theme PR</label> | _(no label)_ |

### Meta labels
Expand All @@ -206,6 +206,7 @@ The following labels provide metadata and are essentially informative:
| <label type="wip">WIP</label> | This PR is a work in progress |
| <label type="e2e">E2E Tests</label> | This PR is about UI automated tests |
| <label type="migration">migration</label> | This PR is about the Symfony migration project |
| <label type="targetedcontributions">Hook Contribution</label> | This PR is about targeted contributions for Hooks |

## Process breakdown

Expand All @@ -215,7 +216,7 @@ Upon opening a PR and you are the first reviewer, please verify:

1. Is the The Pull Request form correctly filled with relevant informations, especially `How to test`?
2. Does the CI pass?
3. When relevant, is there a linked GitHub issue (for bugfixes or new features)?
3. When relevant, is there a linked GitHub issue or discussion (for bugfixes or new features)?

If any of the above items are missing, you can ask the PR author to provide them. Else, you can review the code.

1E0A Expand All @@ -231,7 +232,9 @@ If it has the right number of approvals (Pull Requests submitted to the [PrestaS

You can add `Waiting for QA` label to request a validation from QA team. Some PRs do not need QA testing, for example fixing a typo or a code change that only impacts CI.

If the PR behavior is confirmed by QA Team, the PR can be merged. See above section `Merging Pull Requests` for the different actions needed following the merge.
Some other PRs may require QA by a developer, for example if the PR is very technical and does not change the behavior of the software. In that case, you can add `Waiting for QA` and `Waiting for dev` label. This should be discussed with QA functional team.

If the PR behavior is confirmed by QA Team (or a developer, for the "Waiting for dev PRs), the PR can be merged. See above section `Merging Pull Requests` for the different actions needed following the merge.

[contribution-guidelines]: {{< devdocs "contribute/contribution-guidelines/" >}}
[prestashop-core-repository]: https://github.com/PrestaShop/PrestaShop/
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,4 @@
---
title: How to test Pull Requests and branches
aliases:
- /maintainers-guide/test-pr-and-branches/
---

# How to test Pull Requests

Tests determine the quality of a software. This process involves evaluating that a change works as intended, but above all, that it doesn't provide any unintended side effects.

To make testing easier, we provide a [Vagrant configuration]({{< relref "vagrant.md" >}}) designed for testing branches and pull requests.
layout: redirect
redirect: /project-organization/quality-council/processes/pr-management/
---
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ aliases:
- /maintainers-guide/test-pr-and-branches/vagrant/
---

{{% notice warning %}}
**Vagrant repository is no longer updated.**

To test the PrestaShop pull requests, we recommend using the [Docker environment](https://devdocs.prestashop-project.org/8/contribute/contribute-pull-requests/contribute_using_docker/) or local installation.
{{% /notice %}}

# Using the Vagrant virtual machine

We recommend using our virtual machine to quickly get a testing environment in place.
Expand Down Expand Up @@ -35,10 +41,10 @@ Second, execute the script `run.sh` (or `run.bat` if you're under Windows) and f

Most of the time, there is a prompt asking for a network interface, remember it's the communication between the virtual machine and the network card.

{{< figure src="img/vagrant/run-script.png" alt="Running the run.sh script" >}}
{{< figure src="../img/vagrant/run-script.png" alt="Running the run.sh script" >}}

The first installation will take a while, because it needs to download the vagrant box, installs all needed packages and configures the system to make it compatible with PrestaShop.
{{< figure src="img/vagrant/script-ended-successful.png" alt="Script running successfuly" >}}
{{< figure src="../img/vagrant/script-ended-successful.png" alt="Script running successfuly" >}}

Then, visit [http://192.168.42.42/prestashop](http://192.168.42.42/prestashop).

Expand Down Expand Up @@ -84,8 +90,8 @@ If something went wrong during the installation, the error is displayed explaini

* Invalid branch name:

<img src="img/vagrant/build-failed.png" alt="Invalid git branch name" class="mx-lg-4" style="max-width: 700px">
<img src="../img/vagrant/build-failed.png" alt="Invalid git branch name" class="mx-lg-4" style="max-width: 700px">

* Invalid PHP version:

<img src="img/vagrant/invalid-php-version.png" alt="Invalid PHP version" class="mx-lg-4" style="max-width: 700px">
<img src="../img/vagrant/invalid-php-version.png" alt="Invalid PHP version" class="mx-lg-4" style="max-width: 700px">
23 changes: 22 additions & 1 deletion content/slack/channels.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: Slack channels

A Slack dedicated to the PrestaShop open source project is now available. Its purpose is to foster the development of the software and of its ecosystem. The current priority is to configure channels for development and product management purpose. Once done, it will be open more progressively to other needs, like community management, business, etc.

[More information about prestashop.slack.com](https://github.com/PrestaShop/open-source/blob/master/content/slack/_index.md)
[More information about prestashop.slack.com](../)

## Request a new channel

Expand Down Expand Up @@ -59,6 +59,27 @@ Please note that like any open source project, the main language on this Slack i
- Status: Public
- Language: FR

**#dev-polish**
- Description: For discussions in polish
- Users: For the polish community at large
- Owners: PrestaShop project maintainers
- Status: Public
- Language: PL

**#dev-spanish**
- Description: For discussions in spanish
- Users: For the spanish community at large
- Owners: PrestaShop project maintainers
- Status: Public
- Language: ES

**#dev-italian**
- Description: For discussions in italian
- Users: For the italian community at large
- Owners: PrestaShop project maintainers
- Status: Public
- Language: IT

**#dev-modules**
- Description: The best place on earth to discuss about module development for PrestaShop
- Users: For modules developers of the community
Expand Down
2 changes: 1 addition & 1 deletion themes/ps-org-theme
0