diff --git a/datafiles/templates/upload.html.st b/datafiles/templates/upload.html.st index 994ebc26..f2e972e4 100644 --- a/datafiles/templates/upload.html.st +++ b/datafiles/templates/upload.html.st @@ -36,6 +36,15 @@ of that name and version, including package.cabal. See the notes at the bottom of the page.

+

A Cabal package name can use any alphabetic Unicode code-point, however +Hackage rejects package names that use alphabetic code-points other than those +from the Latin alphabet (that is, A to Z and +a to z). With one exception, the name of a new package +cannot be the same as the name of an existing package, based on a +case-insensitive comparison. The exception is if the maintainer uploading the +new package is a maintainer of the existing package. +

+

Version history and change logs

If a package includes a ChangeLog file (in either plain text or Markdown format), Hackage will link to it on the corresponding package page. The following filenames are recognized:

@@ -66,11 +75,11 @@ See the notes at the bottom of the page.

Package versioning and curation

By default, uploaded packages are curated which means that both maintainers and hackage trustees may revise their metadata (particularly involving version bounds) to guide build tools in producing install-plans. (For more information on revisions, see the FAQ). - +

In order to ensure the integrity and well-functioning of the Hackage/Cabal ecosystem, all curated packages should follow Haskell's Package Versioning Policy (PVP).

In particular, be aware that although the PVP and SemVer are based on the same concepts they differ significantly in structure and consequently are not compatible with each other. Please consult the PVP/SemVer FAQ section for more details about the differences and related issues.

- +

Further, an important property of the PVP contract is that it can only be effective and provide strong enough guarantees if it is followed not only by an individual package, but also by that package's transitive dependencies. Consequently, packages which are curated should aim to depend only on other curated packages.

In the course of the curation process, the @@ -78,13 +87,13 @@ See the notes at the bottom of the page. able to contact package maintainers, to inform them about and help to resolve issues with their packages (including its meta-data) which affect the Hackage ecosystem.

- +

Package uploaders may choose to exclude individual package uploads from curation, by setting the x-curation: field of the package's cabal file to uncurated. Packages which are uncurated have no expectations on them regarding versioning policy. Trustees or maintainers may adopt uncurated packages into the curated layer through metadata revisions. Metadata revisions must not set the value of the x-curation field to any variant of uncurated.

- +

Two variants of the uncurated property are supported. First, uncurated-no-trustee-contact, which indicates that maintainers do not wish to be contacted by trustees regarding any metadata issues with the package. (Contact may still occur over issues that are not related to curation, such as licensing, etc.). Second, uncurated-seeking-adoption, which indicates that maintainers would like their package to be adopted in the curated layer, but currently some issue prevents this, which they would like assistance with.

-

In the future, metadata regarding curation will be made available in the UI of Hackage, and different derived indexes will be provided for the uncurated and curated layers of packages.

- +

In the future, metadata regarding curation will be made available in the UI of Hackage, and different derived indexes will be provided for the uncurated and curated layers of packages.

+

Open source licenses

The code and other material you upload and distribute via this site must be