Výukový program: Jak se stát kompatibilním s REUSE

Tento výukový program vysvětluje základy toho, aby byl softwarový projekt kompatibilní s REUSE. Cílem je snadno, komplexně a jednoznačně deklarovat vaše autorská práva a licence způsobem, který je strojově čitelný. Na konci tohoto tutoriálu pochopíte tři základní kroky REUSE:

1. Výběr a poskytnutí licencí
2. Přidání informací o autorských právech a licenci ke každému souboru
3. Potvrzení souladu s předpisy REUSE

Pro účely tohoto návodu budeme předpokládat, že adresář vašeho projektu vypadá takto:

project/
├── src/
│   └── main.c
├── Makefile
└── README.md

Pokud byste chtěli kroky v tomto tutoriálu reprodukovat na svém počítači, můžete naklonovat vzorové úložiště. Větev nevyhovující odpovídá struktuře výše, zatímco větev vyhovující je úspěšným výsledkem tohoto tutoriálu.

U každého z těchto kroků se nejprve naučíte, jak jich dosáhnout ručně. Nicméně nástroj REUSE vás podporuje s většinou úkolů a potřebné příkazy budou také uvedeny ve skládacích rámečcích. Před samotným prováděním příkazů nástroje doporučujeme nejprve pochopit základní princip.

1. Výběr a poskytnutí licencí

Nejprve je třeba vybrat licenci. Pro tento návod předpokládáme, že jste si vybrali licenci GNU General Public License (GPL) v3.0 nebo jakoukoli novější verzi. Nestačí než jen výběr licence, musíte licenci umístit do adresáře projektu.

Najděte svou licenci v Seznamu licencí SPDX. SPDX je otevřený standard pro sdělování informací o licencích a autorských právech. Každá licence je jednoznačně identifikována krátkým identifikátorem licence SPDX. Identifikátor licence SPDX pro vámi vybranou licenci je GPL-3.0-nebo-novější.

V kořenovém adresáři projektu vytvořte adresář LICENSES/, který bude obsahovat všechny licence, které v projektu používáte. Ve vašem případě to znamená vytvořit v tomto adresáři soubor GPL-3.0-or-later.txt, který bude obsahovat úplné znění licence. Název souboru je identifikátor licence SPDX. Licenční texty mnoha licencí svobodného softwaru najdete v úložišti license-list-data.

2. Do každého souboru přidejte informace o autorských právech a licencích

Nyní, když máte licenci, musíte v příslušných souborech uvést, že tyto soubory spadají pod tuto licenci. Upravte záhlaví komentáře src/main.c takto:

/*
 * SPDX-FileCopyrightText: 2024 Jane Doe <jane@example.com>
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 */

Značka SPDX-FileCopyrightText zaznamenává roky zveřejnění a držitele autorských práv k obsahu souboru. Můžete si přečíst více o které roky publikace použít a jaké jsou držitelé autorských práv v FAQ.

Za značkou SPDX-License-Identifier následuje platné vyjádření licence SPDX, obvykle pouze identifikátor licence SPDX.

Každý soubor musí v záhlaví vždy obsahovat tyto dva tagy. Pokud máte více držitelů autorských práv, můžete značku SPDX-FileCopyrightText použít vícekrát.

V ukázkovém projektu také upravíte Makefile a README.md pomocí těchto hlavičkových informací, ale samozřejmě s odpovídající syntaxí komentářů.

reuse annotate --copyright="Jane Doe <jane@example.com>" --license="GPL-3.0-or-later" src/main.c Makefile README.md

3. Potvrďte soulad s pravidly REUSE

Po přidání licence do vašeho úložiště a přidání informací o autorských právech a licencích do každého souboru bude váš strom projektu nyní vypadat takto:

project/
├── LICENSES/
│   └── GPL-3.0-or-later.txt
├── src/
│   └── main.c
├── Makefile
└── README.md

Abyste měli jistotu, že vám nic neunikne, měli byste potvrdit shodu REUSE pomocí nástroje REUSE. Postupujte podle pokynů k instalaci dostupných pro více platforem, poté přejděte do adresáře projektu a spusťte linter.

$ reuse lint

# SHRNUTÍ

*Špatné licence: 0
* Zastaralé licence: 0
* Licence bez přípony souboru: 0
* Chybějící licence: 0
* Nepoužité licence: 0
* Použité licence: GPL-3.0 nebo novější
* Chyby čtení: 0
* Soubory s informacemi o autorských právech: 3/3
* Soubory s informacemi o licenci: 3/3

Gratulujeme! Váš projekt je v souladu s verzí 3.2 specifikace REUSE :-)

Jak můžete vidět na posledním řádku, nástroj potvrzuje, že váš projekt je nyní v souladu s REUSE! Chcete-li zjistit, co znamenají různá kritéria, podívejte se prosím na dokumentaci příkazu lint.

Více informací

Tento tutoriál byl bleskově rychlým úvodem do REUSE. Nejsou zde pokryty všechny případy použití, zejména [jak komentovat nekomentovatelné soubory] (/cs/faq/#uncommentable-file), [jak hromadně anotovat soubory] () a [jak používat licenci, která není na seznamu SPDX] (/cs/faq/#custom-license). Chcete-li se dozvědět o těchto a praktičtějších případech použití, podívejte se do části [‘Jak mohu …’ v části Často kladené otázky] (/cs/faq/#howto).

Další zdroje pro více informací:

• Naše Často kladené otázky pokrývají běžné otázky i mimořádné případy a budou neustále aktualizovány.
• Specifikace REUSE vám může pomoci v plném pochopení REUSE.
• Instalaci a použití nástroje REUSE popisuje dokumentace k nástroji REUSE.
• V naší nápovědě pro vývojáře jsou uvedeny různé zdroje pro programátory, jako je nástroj, rozhraní API nebo jak zahrnout kontroly do pracovních postupů CI/CD.

Pokud vám žádný z výše uvedených odkazů nedokázal odpovědět na vaši otázku, kontaktujte nás:

• otevření problému na reuse-website pro dotazy k tutoriálu, FAQ nebo specifikaci;
• založením problému na reuse-docs pro dotazy týkající se tutoriálu, FAQ nebo specifikace;
• nebo zasláním e-mailu na adresu FSFE. Vezměte prosím na vědomí, že bychom upřednostňovali vydání, protože jsou veřejně vyhledatelná pro další osoby.

Děkujeme vám za váš cenný příspěvek k opakovanému použití softwaru!