PrestaShop / PrestaShop/open-source

Document dependencies

Open
#2 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

corporations critical high IP management
Dominant language
Shell
Stars
38
Forks
42
Avg merge
3d 18h
Merged PRs (30d)
1

Description

In order to make it easy for non developers to study the dependencies of the PrestaShop open source software, the Devdocs must include a tree of the dependencies, for the core and the native modules.

This must include:

  • Integrated dependencies in the repositories
  • Composer managed dependencies
  • NPM managed dependencies
  • The dependencies of the dependencies
  • And in general, all third party code and libraries used in the project.

A difference must be made between:

  • The dependencies that are built and redistributed in the PrestaShop installer of a release (the zip file)
  • The dependencies used only for development purpose and that are not included in the build

There are two aims:

  • Study and identify dependencies that are not compatible with the OSL license for redistribution
  • Generate comprehensive "third party licenses" files with lists and licences of all the dependencies in the project builds (core and native modules)

In general, please note that the PrestaShop open source project is distributed under the OSL license. It means that in the build/release, only third party code and libraries distributed under the compatible licenses must be used:

  • MIT
  • BSD
  • EUPL
  • AFL
  • OSL

"Development only" dependencies are not built and distributed in the software, so this license restriction does not apply.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Devdocs, the core and native modules, and the release installer zip to map which dependencies are built and redistributed. Review the Composer- and NPM-managed dependencies, including transitive dependencies, and compare development-only dependencies with release contents. Done means the dependency tree and comprehensive third-party license files distinguish redistributed code from development-only code.

Written by the indexing model from the issue text.

Assessment

Domain
build-system, documentation, release
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.