PrestaShop / PrestaShop/docs

Add in the docs dependencies list and licenses

Open
#264 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Scala
Stars
136
Forks
555
Avg merge
4d 14h
Merged PRs (30d)
4

Description

We should add to the devdoc a list of all dependencies and the licenses they use.

This is required for php, css and JS dependencies.
This means:

  • all php dependencies managed through composer
  • maybe, if there are some, php dependencies copy-pasted in the project
  • all JS and CSS dependencies managed through the multiple package.json files
  • JS and CSSdependencies copy-pasted in the project

2 lists are needed:

  • all dependencies, for informative purpose
  • only the dependencies being distributed inside the final ZIP archive, for licensing purpose

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 by locating the Composer-managed PHP dependencies and all package.json files used for JavaScript and CSS dependencies. Check for dependencies copied into the project, then compare the full inventory with what is included in the final ZIP archive. Done means the devdoc contains both dependency lists and the license for each dependency.

Written by the indexing model from the issue text.

Assessment

Tech stack
css, javascript, php
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.