PrestaShop-specs contains the specifications of the PrestaShop software, starting from the PrestaShop 1.7 version.
PrestaShop being an Open Source project, transparency is one of our core values, and it is important for us to make specifications accessible to the community.
Our goal is to have clear and structured specifications available to all. To have a history of the software’s evolutions and to help the people who will be working on it in the future to better understand why we built it this way.
These specifications might help:
- developers who want to understand the expected behaviors of a feature to build,
- developers and users who want to verify if a behavior they are experiencing is normal or is a bug,
- the team maintaining the project, in order to know why some product decisions have been made and to have an overview of the current state of the software,
- anyone who is interested in the project and want to know it better.
The repository is maintained by the Product team at PrestaShop.
For the moment not all specifications are in this repository. They will be created and added progressively. Contributions are Welcome!
What are specifications?
To quote Joel Spolsky,
- A functional specification describes how a product will work entirely from the user’s perspective. It doesn’t care how the thing is implemented. It talks about features. It specifies screens, menus, dialogs, and so on.
- A technical specification describes the internal implementation of the program. It talks about data structures, relational database models, choice of programming languages and tools, algorithms, etc.
Having specifications is critical when building a new feature. But it is also useful to store them and to be able to browse them later, to understand how a feature is working and what are the expected behaviors. That is why we decided to create this repository.
Our specifications at PrestaShop are mostly functional, but include some technical information too, when needed.
Advanced technical concepts are covered in the Developer Documentation.
How does this repository work?
To easily track all specifications evolutions in the future we decided to rely on the Git data model. Each commit to the repository is saved, allowing anyone to navigate through a specification's history.
Moreover, each addition or modification of a spec file must be done through the creation of a Pull Request (PR) in which the reasons for such modification must be detailed.
It is thus possible to check how was the specs a feature before, by using git tools to compare the differences in content. And to know why it was modified in the Pull Request's description.
(The use of branches to have up-to-date specs for each minor version of PrestaShop is under consideration.)
Relation between the specifications repository and the development repository
Everytime a developper works on PrestaShop, he/she is assigned or self-assigned a development issue. Each issue corresponds to a task.
These development issues are located in the PrestaShop repository
In order to complete the task, most of the time, a developer needs specifications.
These specifications are located here in this repository
So in each development issue should be a link to the corresponding specification.
Process when working on a new feature
Considered the use of the git data model detailed in the previous part, the specification must be added to the corresponding file (or files) through a Pull Request. If the file related to this feature does not exist yet, it should be created.
Specifications must be validated by the core team (product, dev, and QA) and merged before the development begins. Once the specs are validated, the link to this PR must then be added in the development issue, so the developer can easily find the specifications associated with the issue.
The specifications' PR must then be merged into the PrestaShop develop branch in the repository
PrestaShop/PrestaShop, the development phase can start. If any behavior is redefined during this phase, specs must be updated accordingly.
Process when working on a bug
If the corresponding specification exists Then add a link in the development issue to the specification in the master branch of this repository.
If the specification doesn't exist Then, first you need to validate with the Product team what is the right behavior that should be specified. Then, you can follow the same process as for a new feature or improvement, by creating a PR.
This is the main template to follow to write specifications.
When possible, each file corresponds to a page.
When not possible, template can be adapted, but it is important to have the information listed in the template as possible.
The repository contains 4 main directories:
back-officedirectory mostly follows the back office structure. Most files contain the specifications for a BO page, e.g. the product page.
broader-topicsdirectory covers all topics and behaviours shared throughout the software, and that are not limited to the BO or FO, e.g. the SEO strategy throughout the software.
front-officedirectory lists the pages in the front office and shared behaviors throughout the pages, e.g. the product images.
modulesdirectory includes all specifications for built-in (“native”) modules, e.g. the Faceted Search module.
How to contribute
Contributions are welcome! To learn more, please have a look at the CONTRIBUTING.md page.
Running the application locally
First download a binary of Hugo from hugo GitHub releases page. You need to select the binary that suits your environment.
Then clone the project
git clone https://github.com/PrestaShop/prestashop-specs.git
This application uses the ps-docs-theme Hugo theme. It is embedded as a git submodule, so you need to check it out too:
git pull --recurse-submodules git submodule update --init --recursive
Now you use hugo built-in server:
It will prompt an URL you can browse to see the application.