ForkAwesome/Fork-Awesome

split up LICENSES

Open

#343 opened on Sep 4, 2021

View on GitHub
 (0 comments) (1 reaction) (0 assignees)HTML (1,293 stars) (149 forks)batch import
enhancementgood first issue

Description

Currently, we have one LICENSES file in the repository that contains the license text for all 3 licenses that we use for the project. This is not ideal and is not machine-readable.

The FSFE REUSE Software website FAQ lists How to properly declare multi-licensing?.

You should always include all licenses in the LICENSES/ directory.

What we need to do is to replace the LICENSES blob with a directory containing the different licenses we have in the project.

We have 3 different kinds of licenses that applies to different parts in the repository :

  • the font itself is licensed under the SIL OFL 1.1 all files contained within the fonts and src/icons/svg directories fall under this license.
  • the auxiliary style-sheets - CSS, Less, SCSS use the MIT license
  • everything else that do not fall under the above 2 categories are licensed under CC-BY-3.0

Contributor guide

Tech stack
csshtml
Domain
documentation
Issue type
chore
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Git basicsGitHub pull request workflow
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
First, examine the current LICENSES file to confirm the three licenses (SIL OFL 1.1, MIT, CC BY 3.0). Then, create a LICENSES/ directory and add the full text of each license as separate files (e.g., OFL 1.1, MIT, CC BY 3.0). Ensure to remove or update any references to the old LICENSES file in README or other documentation. Follow the FSFE REUSE guidelines for file naming and structure.