ForNeVeR / ForNeVeR/dotnet-authors

REUSE metadata traversal

Open
#82 0 comments 0 reactions 0 assignees View on GitHub
enhancement good first issue help wanted
Dominant language
F#
Stars
3
Forks
0
Avg merge
2m
Merged PRs (30d)
2

Description

There should be a command in format:
```console
$ dotnet authors --source reuse --target json --output authors.json
```
(other potential `--source` in the future will be `git`, and other potential `--target` will be `reuse`)

Which should collect the copyright holders from the REUSE files according to the config (if passed) and produce the `authors.json` file.

Resulting data format example:
```json
{ "authors": [{
"name": "Friedrich von Never",
"contact": [{
"url": "mailto:friedrich@fornever.me"
}, {
"info": "any optional text info"
}]
]}}
```

`contact` may consist of different entries in case there are different copyright entries in different files.

URLs should be valid (thus dotnet-authors should recognize at least `mailto:` and `https://` correctly when needed).

In the future, config will help to deduplicate authors.

There's nothing wrong in exposing the author info this way since they are stored in the REUSEable sources anyway.

Contributor guide

Open the contributing guide

Research direction

Start at the CLI entry point for the `dotnet authors` command and trace how command options and output targets are handled. Implement the `--source reuse --target json --output authors.json` flow using REUSE copyright entries, with the shown authors/contact JSON shape and support for `mailto:` and `https://` URLs. Done means the command produces the expected file from configured REUSE metadata.

Written by the indexing model from the issue text.

Assessment

Tech stack
fsharp
Domain
cli
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.