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

Package also CHANGELOG / LICENSE files #671

Open
janihur opened this issue Dec 20, 2024 · 1 comment
Open

Package also CHANGELOG / LICENSE files #671

janihur opened this issue Dec 20, 2024 · 1 comment
Labels
customer enhancement New feature or request

Comments

@janihur
Copy link

janihur commented Dec 20, 2024

Currently only README is included into the compressed source code archive file (zpm package).

Include also CHANGELOG / LICENSE files if they are available.

You can of course include all information into README but I have found it very useful to separate the changelog information.

Promote the conventions defined in https://keepachangelog.com/en/1.1.0/ (that's exactly how I do changelogs atm). This also promotes semver.

Considering the open source aspect of the IPM ecosystem the explicit licensing information should be expected from all modules publicly available.

@isc-tleavitt isc-tleavitt added enhancement New feature or request customer labels Dec 20, 2024
@isc-tleavitt
Copy link
Contributor

Agreed on this, good points all around. We also have adopted that changelog convention on all of my team's active open source stuff (including IPM).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
customer enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants