chocolatey / chocolatey/choco

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

Open
#2,217 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
C#
Stars
11.5k
Forks
961
PR merge metrics
No merged PRs in 30d

Description

# 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 :

```# NOTE

: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.

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

## Files Checksum

Included binaries are :

| `checksum` | `filename.ext` |
| ------------------------------------------------------------------- | -------------- |
| bf85381a12954793d5a18f252579cb1bc043aada2c34ac0974e2ab8cf03a1de3 | `./foo.exe` |
```

Contributor guide

Open the contributing guide

Research direction

Start at the `choco new` entry point and trace how it creates LICENSE.txt and VERIFICATION.txt. Confirm whether the proposed Markdown templates fit the existing package layout and locate any related tests. Done means `choco new` generates the two requested `.md` files with the agreed review and verification content.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, markdown
Domain
cli, documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.