Search code examples
npmreleasechangelog

What are standard project README and CHANGELOG variants?


npm's developer documentation, describes README and CHANGELOG as having variants, without describing what they may be.

README (and its variants)

CHANGELOG (and its variants)

Is there a standard set of variants? If so, where would those standards be published?


Solution

  • The variants are clarified in the documentation on package.json#files field.

    Changelog can be named CHANGES, CHANGELOG or HISTORY with any case and extension. README file has the same naming flexibility.