Skip to content

Standard CHANGELOG CONTRIBUTING LICENSE README for app repos #610

Open
@phil-davis

Description

@phil-davis

Some app repos have all of these files, but some are missing:

  • CHANGELOG.md - has been created recently in most app repos

  • CONTRIBUTING.md - missing in quite a lot of app repos

  • LICENSE or LICENSE.md - missing in quite a lot of app repos

  • README.md - exists

  • Add any that are missing

  • Adjust app Makefile to include them in the app release tarball

  • Check that the content is OK

Questions:

LICENSE seems to be for when it is just plain text GPL etc license pasted in. Existing ones are either GPL v2 or v3. When creating a new LICENSE file, do we paste in v2 or v3 by default?

LICENSE.md seems to be for when there is a different/special license that has formatting. I guess we use the .md extension when needed?

CHANGELOG.md LICENSE and README.md are typically written into the app release tarball. Should we also put CONTRIBUTING.md in the tarball?

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions