Skip to content

Clarify naming convention (project branding)Β #40

@hugolpz

Description

@hugolpz

Ambiguity comes from MediaWiki API already commonly known as the wiki api.

Recommendation πŸ’― πŸš€ πŸ‘¨πŸΌβ€πŸŽ€

  • Wikiapi.js (capitalized + javascript indicator) - for human-oriented documentation text, readme.md, wiki, community announcements, emails, etc. Minor arternative WikiapiJS.
  • wikiapijs (lowercase) - for computer-friendly url, hashtags, tags.
  • wikiapi (lowercase) - for incode usage within .js files, github repository name, npm (which is already a js ecosystem). Note: Rename npm package is bad for dependencies, cannot do there.

D3js case

Same practice as for D3.js (in human conversation), d3js (in hashtags), and d3 (in .js files and npm).
Important to note : D3 has no ambiguity with another homonyme "D3" project. We do.

Screenshot_2021-04-06_11-50-22

Github rename

Do you mean that renaming on github changes the package's name on npm ?

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions