Add a page on cabal package metadata #65
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
michaelpj
force-pushed
the
mpj/cabal-metadata
branch
from
6a4ea3d to
0f0f614
Compare
coot
reviewed
May 18, 2023
coot
reviewed
May 18, 2023
| | `license-file` | Omit in favour of `license-files`. | | Apache 2.0 requires multiple license files. | | ||
| | `license-files` | Must include both `LICENSE` and `NOTICE`. | `LICENSE NOTICE` | See the [legal policy page](../../legal/index.html). | | ||
| | `copyright` | Omit. | | See the [legal policy page](../../legal/index.html). | | ||
| | `author` | Omit. | | Typically there is no clear single author of a package. | |
There was a problem hiding this comment.
Some of our packages have authors so they should be honoured, but it's ok to omit this field in most of our packages.
| | `package-url` | Omit. | | Not relevant. | | ||
| | `synopsis` | No policy. | | | | ||
| | `description` | No policy. | | | | ||
| | `category` | Omit. | | This has never really caught on even in the Haskell OSS community. | |
There was a problem hiding this comment.
I think it should be set for packages that are published on Hackage.
There was a problem hiding this comment.
Really? It seems to be rarely used even on Hackage.
There was a problem hiding this comment.
https://hackage.haskell.org/packages/ shows quite a lot of categories indeed. I guess we can say optional 🤷
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Some controversial bits in here, and some that rely on us getting agreement on the legal stuff. But putting this up as a draft anyway.