Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify naming convention (project branding) #40

Open
hugolpz opened this issue Apr 6, 2021 · 5 comments
Open

Clarify naming convention (project branding) #40

hugolpz opened this issue Apr 6, 2021 · 5 comments
Labels
documentation Improvements or additions to documentation

Comments

@hugolpz
Copy link
Collaborator

hugolpz commented Apr 6, 2021

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 ?

@kanasimi kanasimi added the documentation Improvements or additions to documentation label Apr 6, 2021
@hugolpz
Copy link
Collaborator Author

hugolpz commented Apr 6, 2021

After thinking. I thing we can dissociate npm&github url (using wikiapi) from other usage in documentation and texts (using Wikiapi.js).

@kanasimi
Copy link
Owner

kanasimi commented Apr 6, 2021

Since the repositories depended on wikiapi almost use only one library to contact to MediaWiki, there is no ambiguity, the class name Wikiapi should be properly.
I will rename the wikiapi.js to Wikiapi.js, as a class codes of Wikiapi, and left the sample codes unchanged.

@hugolpz
Copy link
Collaborator Author

hugolpz commented Apr 6, 2021

  • My point is mostly for human communication : readme.md, wikipages, project's descriptions, etc. When we tell someone "I'm working with... Wikiapi.js", "You may try Wikiapi.js", etc.
  • Tags, hashtags are not controversial : #wikiapijs.
  • Sample codes can stay wikiapi.some_method() yes. Same for repositories (npm, github).

So it seems we are set for our naming convention !
Issue 40 to close when the doc, readme are up to it. πŸ₯³

@kanasimi
Copy link
Owner

kanasimi commented Apr 6, 2021

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

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

  • WikiapiJS, Wikiapi.js (capitalized + javascript indicator) - for human-oriented documentation text, readme.md, wiki, community announcements, emails, etc.
  • 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.

I agree the recommendation.
I think we can call our project WikiapiJS or Wikiapi.js in general talking, not to confused with API of MediaWiki, it is OK.
For tags, we use wikiapijs, it is just completed.
And using wikiapi as instance of class Wikiapi. It is what we doing now.

For WikiapiJS and Wikiapi.js, which one is better? I do not have idea...

@hugolpz
Copy link
Collaborator Author

hugolpz commented Apr 6, 2021

Same. Let me few days to think the pro and con and I will make a recommendation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants