pml-lang / pml-changelog Goto Github PK

I find the repository name fairly problematic, for various reasons, and I believe it ought to be renamed to pml-changelog or pmlc-changelog, depending on whether you consider this Changelog as pertaining to the PML syntax in general, or to the PMLC tool specifically.

1. Each repository name in a user account must be unique and (IRC) GitHub treats users and repository names case-insensitively, to avoid emulators and hackers "hijacking" a project or account via letter-case tweaks (i.e. only repository internal paths are case-sensitive).

   Imagine if multiple tools (beside PMLC) would name their Changelog repository as changelog ,,, then users won't be able to fork more than one such repositories due to name-uniqueness restrictions. For this reason I'd argue that the current name violates good repository naming conventions.

   Even worst, a GH organization associated to a specific tool which they develop might be reluctant to fork this repository lest its users might erroneously deduce it's the official Changelog of their main product (by seeing it listed under their org repositories list this might be a reasonable deduction). Surely, one can rename a fork without affecting its upstream Git connection ... but the need for such workarounds is, in itself, a telltale sign that something is wrong with the repository name, since this shouldn't happen in the first place.

2. The name changelog doesn't deliver any useful information on its own. Without the pml- or pmlc- prefix it becomes unclear what the repository is all about, especially in other users forks where the pml-lang account name is not present, leaving anyone who stumbles upon them clueless about what product the Changelog refers to.

   This will also hinder discovery on GitHub searches and its indexing via labels and topics — even if you add all the PML related labels (pml, pmlc, lightweight-markup, etc.) the repository name keywords (i.e. its hyphen-/underscore-separated constituents) are crucial for GitHub to determine the main repository category of belonging (similar to Google ranking for search results).