chocolatey / choco

Chocolatey - the package manager for Windows
https://chocolatey.org
Other
10.33k stars 903 forks source link

"choco new" > Switch LICENSE.txt and VERIFICATION.txt to markdown (from `.txt` to `md`) #2217

Open adriens opened 3 years ago

adriens commented 3 years ago

Context

The idea is to make these two files even easier to review by putting markdown into them when running the choco new, which may encourage people to put a cleaner (easier to read) content.

Proposals

LICENCE.md

Here is the proposeed content :

# Note

:warning:Include this file if including binaries you have the right to distribute, **Otherwise delete this file.**

===DELETE ABOVE THIS LINE AND THIS LINE===

From: [the target license name](insert applicable license url here)

# LICENSE

:point_down:Put the license below :

```License body here```

VERIFICATION.md

Template proposal below :


:warning:Include this file **only if including binaries you have the right to distribute.**

Otherwise delete. this file. If you are the software author, you can change this mention you are the author of the software.

===DELETE ABOVE THIS LINE AND THIS LINE===

# VERIFICATION

Verification is intended to assist the Chocolatey moderators and community
in verifying that this package's contents are trustworthy.

<Include details of how to verify checksum contents>
<If software vendor, explain that here - checksum verification instructions are optional>

See exemple below (please replace with your own content) :

## Files Checksum

Included binaries are :

| `checksum`                                                          | `filename.ext` |
| ------------------------------------------------------------------- | -------------- |
| bf85381a12954793d5a18f252579cb1bc043aada2c34ac0974e2ab8cf03a1de3    | `./foo.exe`    |
TheCakeIsNaOH commented 3 years ago

I am not completely opposed to this, but I think first that the community repository should be able to support rendering these as markdown before this gets switched over on the choco side.

AdmiringWorm commented 3 years ago

Not sure if makes sense to change the license to default to markdown. Commonly (and my preference) is to have the license file equal to the upstream license, without additional information and from my experience most license files are written in pure text and not markdown.

If memory serves right though, the verifier allows the name of the files to be LICENSE.txt, LICENSE.md, LICENSE, COPYING.txt, COPYING.md and COPYING (not sure if it supports LICENCE with a C instead of S though).

I do agree that it makes sense to change the VERIFICATION.txt file to use VERIFICATION.md instead, and especially if the community repository implements support for displaying that file as correct markdown (that is a different issue though).

adriens commented 3 years ago

@AdmiringWorm totally agree for licence 👍

And for :

I do agree that it makes sense to change the VERIFICATION.txt file to use VERIFICATION.md instead, and especially if the community repository implements support for displaying that file as correct markdown (that is a different issue though).

Glad to read this, it should make the review process easier 👏