Template: FSDG Checklist

From LibrePlanet
Jump to: navigation, search
m (add note)
(clarify application instructions)
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
<noinclude>
 
<noinclude>
 +
This is the standard GNU Free System Distribution Guidelines (FSDG) fitness checklist template for [https://libreplanet.org/wiki/Incoming_distros#Endorsement_Process Software Distributions (distros) seeking FSF endorsement].
 +
It should instantiated at the beginning of the community evaluation phase, for each prospective distro, by the community-appointed review manager for that distro.
 
To use this template:
 
To use this template:
* Create a new page with the name of the distro
+
* Create a new wiki page, reflecting the name of the host.
* Add the framed text below as the body of the new page
+
* Add the framed text below as the body of the new page.
* Each line beginning with a pipe '|' corresponds to one of the checklist criteria
+
* The label of each criteria in the rendered checklist table, will be a hyper-link to the relevant section of the [https://www.gnu.org/distros/free-system-distribution-guidelines.html FSDG].
* Retain the equals sign as the last character of each such line until that criteria passes
+
* The 'TODO' place-holder or later, the evaluation notes, will be shown beneath each criteria in the rendered checklist table.
* Any text following the equals sign on any criteria line indicates a pass for that criteria
+
 
 +
To populate this template:
 +
* Each line beginning with a pipe character ('|'), corresponds to one of the checklist criteria.
 +
* The 'TODO' place-holder, following the equals character ('=') on each such line, may be replaced with arbitrary notes. Newlines are acceptable; but avoid using the pipe '|' character.
 +
* There must be some text following the equals character ('=') on each such line, until that criteria passes.
 +
* Any text following an equals character ('=') on any such line, indicates a pending (or failing) state for that criteria (status indicator: ☐ will be shown).
 +
* As each criteria passes review, delete all text following the equals character ('=') on the corresponding line (status indicator: ☑ will be shown).
 +
 
 
<pre>
 
<pre>
 
{{FSDG_Checklist
 
{{FSDG_Checklist
|complete-distros=
+
|complete-distros=TODO
|no-name-confusion=
+
|no-name-confusion=TODO
|no-trademark-issues=
+
|no-trademark-issues=TODO
|actively-maintained=
+
|actively-maintained=TODO
|fixes-mistakes=
+
|fixes-mistakes=TODO
|avoids-propaganda=
+
|avoids-propaganda=TODO
|non-dsfg-software-cleansed=
+
|non-dsfg-software-cleansed=TODO
|no-nonfree-firmware=
+
|no-nonfree-firmware=TODO
|no-nonfree-software=
+
|no-nonfree-software=TODO
|no-nonfree-documentation=
+
|no-nonfree-documentation=TODO
|no-nonfree-functional=
+
|no-nonfree-practical=TODO
|no-nonfree-nonfunctional=
+
|no-nonfree-nonfunctional=TODO
|no-encourage-nonfree=
+
|no-encourage-nonfree=TODO
|no-malware=
+
|no-malware=TODO
 
}}
 
}}
 
</pre>
 
</pre>
  
The rendered distro page will resemble the table below with check-marks <span style="font-size:24px">☑</span> beside each passing criteria.
+
The rendered checklist page will resemble the table below, with boxes <span style="font-size:24px">☐</span> beside each pending criteria, and check-marks <span style="font-size:24px">☑</span> beside each passing criteria.
 +
 
 +
== Sample Checklist: ==
 +
 
 
</noinclude>
 
</noinclude>
 
+
This is the FSDG-fitness checklist for {{ #ifeq: {{SUBPAGENAME}} | FSDG Checklist | <DISTRO_NAME> | {{SUBPAGENAME}} }} as compiled by the [[Group:FreedSoftware | Community Workgroup for fully free GNU/Linux distributions]].
 +
The text of each criteria in the checklist table is a hyper-link to the relevant section of the FSDG.
 +
Additional tips for reviewers may be found in the [[FSDG Review Guide]].
 +
Please send any questions or comments to the [https://lists.gnu.org/mailman/listinfo/gnu-linux-libre gnu-linux-libre mailing list].
  
 
{| class="wikitable"
 
{| class="wikitable"
!colspan="2"|FSDG Checklist for {{SUBPAGENAME}}
+
! colspan="2" | FSDG Checklist for {{ #ifeq: {{SUBPAGENAME}} | FSDG Checklist | <DISTRO_NAME> | {{SUBPAGENAME}} }}
 
|-
 
|-
| <span style="font-size:24px">{{ #if: {{{complete-distros           |}}} | ☑ | ☐  }}</span>
+
| <span style="font-size:24px">{{ #if: {{{complete-distros         |}}} | ☐ | ☑ }}</span>
 
| [https://www.gnu.org/distros/free-system-distribution-guidelines.html#complete-distros Complete Distro]
 
| [https://www.gnu.org/distros/free-system-distribution-guidelines.html#complete-distros Complete Distro]
 +
  {{ #if: {{{complete-distros          |}}} | NOTES: {{{complete-distros          |}}} }}
 
|-
 
|-
|<span style="font-size:24px">{{ #if: {{{no-name-confusion           |}}} | ☑ | ☐  }}</span>
+
| <span style="font-size:24px">{{ #if: {{{no-name-confusion         |}}} | ☐ | ☑ }}</span>
 
| [https://www.gnu.org/distros/free-system-distribution-guidelines.html#name-confusion No name confusion]
 
| [https://www.gnu.org/distros/free-system-distribution-guidelines.html#name-confusion No name confusion]
 +
  {{ #if: {{{no-name-confusion        |}}} | NOTES: {{{no-name-confusion        |}}} }}
 
|-
 
|-
|<span style="font-size:24px">{{ #if: {{{no-trademark-issues         |}}} | ☑ | ☐  }}</span>
+
| <span style="font-size:24px">{{ #if: {{{no-trademark-issues       |}}} | ☐ | ☑ }}</span>
 
| [https://www.gnu.org/distros/free-system-distribution-guidelines.html#trademarks No other trademark issues]
 
| [https://www.gnu.org/distros/free-system-distribution-guidelines.html#trademarks No other trademark issues]
 +
  {{ #if: {{{no-trademark-issues      |}}} | NOTES: {{{no-trademark-issues      |}}} }}
 
|-
 
|-
| <span style="font-size:24px">{{ #if: {{{actively-maintained       |}}} | ☑ | ☐  }}</span>
+
| <span style="font-size:24px">{{ #if: {{{actively-maintained       |}}} | ☐ | ☑ }}</span>
 
| [https://www.gnu.org/distros/free-system-distribution-guidelines.html#maintenance Actively maintained]
 
| [https://www.gnu.org/distros/free-system-distribution-guidelines.html#maintenance Actively maintained]
 +
  {{ #if: {{{actively-maintained      |}}} | NOTES: {{{actively-maintained      |}}} }}
 
|-
 
|-
| <span style="font-size:24px">{{ #if: {{{fixes-mistakes             |}}} | ☑ | ☐  }}</span>
+
| <span style="font-size:24px">{{ #if: {{{fixes-mistakes           |}}} | ☐ | ☑ }}</span>
 
| [https://www.gnu.org/distros/free-system-distribution-guidelines.html#mistakes Commitment to correct mistakes]
 
| [https://www.gnu.org/distros/free-system-distribution-guidelines.html#mistakes Commitment to correct mistakes]
 +
  {{ #if: {{{fixes-mistakes            |}}} | NOTES: {{{fixes-mistakes            |}}} }}
 
|-
 
|-
| <span style="font-size:24px">{{ #if: {{{avoids-propaganda         |}}} | ☑ | ☐  }}</span>
+
| <span style="font-size:24px">{{ #if: {{{avoids-propaganda         |}}} | ☐ | ☑ }}</span>
 
| [https://www.gnu.org/distros/free-system-distribution-guidelines.html#words-to-avoid Avoids repeating propaganda or creating confusion]
 
| [https://www.gnu.org/distros/free-system-distribution-guidelines.html#words-to-avoid Avoids repeating propaganda or creating confusion]
 +
  {{ #if: {{{avoids-propaganda        |}}} | NOTES: {{{avoids-propaganda        |}}} }}
 
|-
 
|-
| <span style="font-size:24px">{{ #if: {{{non-dsfg-software-cleansed |}}} | ☑ | ☐  }}</span>
+
| <span style="font-size:24px">{{ #if: {{{non-dsfg-software-cleansed|}}} | ☐ | ☑ }}</span>
| [https://libreplanet.org/wiki/List_of_software_that_does_not_respect_the_Free_System_Distribution_Guidelines No software from the List of software that does not respect the FSDG]
+
| [https://libreplanet.org/wiki/List_of_software_that_does_not_respect_the_Free_System_Distribution_Guidelines Programs commonly known to have freedom issues are liberated or excluded]
 +
  {{ #if: {{{non-dsfg-software-cleansed|}}} | NOTES: {{{non-dsfg-software-cleansed|}}} }}
 
|-
 
|-
| <span style="font-size:24px">{{ #if: {{{no-nonfree-firmware       |}}} | ☑ | ☐  }}</span>
+
| <span style="font-size:24px">{{ #if: {{{no-nonfree-firmware       |}}} | ☐ | ☑ }}</span>
 
| [https://www.gnu.org/distros/free-system-distribution-guidelines.html#nonfree-firmware No non-free firmware or binary blobs]
 
| [https://www.gnu.org/distros/free-system-distribution-guidelines.html#nonfree-firmware No non-free firmware or binary blobs]
 +
  {{ #if: {{{no-nonfree-firmware      |}}} | NOTES: {{{no-nonfree-firmware      |}}} }}
 
|-
 
|-
| <span style="font-size:24px">{{ #if: {{{no-nonfree-software       |}}} | ☑ | ☐  }}</span>
+
| <span style="font-size:24px">{{ #if: {{{no-nonfree-software       |}}} | ☐ | ☑ }}</span>
 
| [https://www.gnu.org/distros/free-system-distribution-guidelines.html#license-rules All software under a free license with source code provided]
 
| [https://www.gnu.org/distros/free-system-distribution-guidelines.html#license-rules All software under a free license with source code provided]
 +
  {{ #if: {{{no-nonfree-software      |}}} | NOTES: {{{no-nonfree-software      |}}} }}
 
|-
 
|-
| <span style="font-size:24px">{{ #if: {{{no-nonfree-documentation   |}}} | ☑ | ☐  }}</span>
+
| <span style="font-size:24px">{{ #if: {{{no-nonfree-documentation |}}} | ☐ | ☑ }}</span>
 
| [https://www.gnu.org/distros/free-system-distribution-guidelines.html#documentation Documentation under a free license]
 
| [https://www.gnu.org/distros/free-system-distribution-guidelines.html#documentation Documentation under a free license]
 +
  {{ #if: {{{no-nonfree-documentation  |}}} | NOTES: {{{no-nonfree-documentation  |}}} }}
 
|-
 
|-
| <span style="font-size:24px">{{ #if: {{{no-nonfree-functional     |}}} | ☑ | ☐  }}</span>
+
| <span style="font-size:24px">{{ #if: {{{no-nonfree-practical     |}}} | ☐ | ☑ }}</span>
 
| [https://www.gnu.org/distros/free-system-distribution-guidelines.html#license-rules Other "Information for practical use" under a free license]
 
| [https://www.gnu.org/distros/free-system-distribution-guidelines.html#license-rules Other "Information for practical use" under a free license]
 +
  {{ #if: {{{no-nonfree-practical      |}}} | NOTES: {{{no-nonfree-practical      |}}} }}
 
|-
 
|-
| <span style="font-size:24px">{{ #if: {{{no-nonfree-nonfunctional   |}}} | ☑ | ☐  }}</span>
+
| <span style="font-size:24px">{{ #if: {{{no-nonfree-nonfunctional |}}} | ☐ | ☑ }}</span>
 
| [https://www.gnu.org/distros/free-system-distribution-guidelines.html#non-functional-data All "non-functional" data must be freely distributable]
 
| [https://www.gnu.org/distros/free-system-distribution-guidelines.html#non-functional-data All "non-functional" data must be freely distributable]
 +
  {{ #if: {{{no-nonfree-nonfunctional  |}}} | NOTES: {{{no-nonfree-nonfunctional  |}}} }}
 
|-
 
|-
| <span style="font-size:24px">{{ #if: {{{no-encourage-nonfree       |}}} | ☑ | ☐  }}</span>
+
| <span style="font-size:24px">{{ #if: {{{no-encourage-nonfree     |}}} | ☐ | ☑ }}</span>
 
| [https://www.gnu.org/distros/free-system-distribution-guidelines.html#license-rules Does not encourage users to use or install non-free software]
 
| [https://www.gnu.org/distros/free-system-distribution-guidelines.html#license-rules Does not encourage users to use or install non-free software]
 +
  {{ #if: {{{no-encourage-nonfree      |}}} | NOTES: {{{no-encourage-nonfree      |}}} }}
 
|-
 
|-
| <span style="font-size:24px">{{ #if: {{{no-malware                 |}}} | ☑ | ☐  }}</span>
+
| <span style="font-size:24px">{{ #if: {{{no-malware               |}}} | ☐ | ☑ }}</span>
 
| [https://www.gnu.org/distros/free-system-distribution-guidelines.html#no-malware No Malware]
 
| [https://www.gnu.org/distros/free-system-distribution-guidelines.html#no-malware No Malware]
 +
  {{ #if: {{{no-malware                |}}} | NOTES: {{{no-malware                |}}} }}
 
|}
 
|}

Latest revision as of 06:13, 6 April 2021

This is the standard GNU Free System Distribution Guidelines (FSDG) fitness checklist template for Software Distributions (distros) seeking FSF endorsement. It should instantiated at the beginning of the community evaluation phase, for each prospective distro, by the community-appointed review manager for that distro. To use this template:

  • Create a new wiki page, reflecting the name of the host.
  • Add the framed text below as the body of the new page.
  • The label of each criteria in the rendered checklist table, will be a hyper-link to the relevant section of the FSDG.
  • The 'TODO' place-holder or later, the evaluation notes, will be shown beneath each criteria in the rendered checklist table.

To populate this template:

  • Each line beginning with a pipe character ('|'), corresponds to one of the checklist criteria.
  • The 'TODO' place-holder, following the equals character ('=') on each such line, may be replaced with arbitrary notes. Newlines are acceptable; but avoid using the pipe '|' character.
  • There must be some text following the equals character ('=') on each such line, until that criteria passes.
  • Any text following an equals character ('=') on any such line, indicates a pending (or failing) state for that criteria (status indicator: ☐ will be shown).
  • As each criteria passes review, delete all text following the equals character ('=') on the corresponding line (status indicator: ☑ will be shown).
{{FSDG_Checklist
|complete-distros=TODO
|no-name-confusion=TODO
|no-trademark-issues=TODO
|actively-maintained=TODO
|fixes-mistakes=TODO
|avoids-propaganda=TODO
|non-dsfg-software-cleansed=TODO
|no-nonfree-firmware=TODO
|no-nonfree-software=TODO
|no-nonfree-documentation=TODO
|no-nonfree-practical=TODO
|no-nonfree-nonfunctional=TODO
|no-encourage-nonfree=TODO
|no-malware=TODO
}}

The rendered checklist page will resemble the table below, with boxes beside each pending criteria, and check-marks beside each passing criteria.

Sample Checklist:

This is the FSDG-fitness checklist for <DISTRO_NAME> as compiled by the Community Workgroup for fully free GNU/Linux distributions. The text of each criteria in the checklist table is a hyper-link to the relevant section of the FSDG. Additional tips for reviewers may be found in the FSDG Review Guide. Please send any questions or comments to the gnu-linux-libre mailing list.

FSDG Checklist for <DISTRO_NAME>
Complete Distro
No name confusion
No other trademark issues
Actively maintained
Commitment to correct mistakes
Avoids repeating propaganda or creating confusion
Programs commonly known to have freedom issues are liberated or excluded
No non-free firmware or binary blobs
All software under a free license with source code provided
Documentation under a free license
Other "Information for practical use" under a free license
All "non-functional" data must be freely distributable
Does not encourage users to use or install non-free software
No Malware