Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for more project metadata #71

Open
kylewlacy opened this issue Jul 4, 2024 · 0 comments
Open

Add support for more project metadata #71

kylewlacy opened this issue Jul 4, 2024 · 0 comments

Comments

@kylewlacy
Copy link
Member

The top-level export const project in a project can currently include the fields name and version (extra fields can be included, but aren't semantically meaningful). We should support some other useful fields too:

  • website: Link to official project website
  • license: SPDX license specifier

There might be some other fields like repository, issueTracker, authors, etc that might also be worth adding, but website and license are a minimum good starting point as many users are likely going to want to know these details at a glance. Adding these details now will also be helpful if/when the registry has an interface for exploring packages, where listing the license and website details up-front will be helpful

Licensing details can also get complicated, such as ffmpeg builds that can be legally-encumbered and not redistributable depending on what codecs are enabled at build time. We can punt on handling these kinds of edge cases for now, and just say that the license field should be set based on the project's license and source code, and should only be set if it's unambiguous what the resulting license will be for every build

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant