search

kanasimi / wikiapi

JavaScript MediaWiki API for node.js
https://kanasimi.github.io/wikiapi/
BSD 3-Clause "New" or "Revised" License
50 stars 6 forks source link

March 2021 review #33

Closed hugolpz closed 3 years ago

hugolpz commented 3 years ago

This issue is only a review and outline of associated issues. Please discuss on related issues.

General review

I like to write documentations and plan to do a push on wikiapi readme.md.[1] I still have to understand the project better. Today I understood that you base your parameters naming convention upon MediaWiki API. 🥇 I still have to understand more stuff before attacking your README.md. Your project is elegant, the code is easy to write and understand, and the development is active which is great. Your project has two major weak points :

Key Point Actionable
Doc The manual via examples is insufficient, noisy, too many things are opaques (parameters) Needs to revamp the Readme.md
Devs The lack of a multi-developers community. All stands on yourself. It's not distributed enough. Needs to onboard 1~2 other JS devs of your level or understanding your ES6 code.

A better readme will help to call over new devs. While @kanasimi works great alone, for sustainability it is better to have teammates and reviewers, who can fix things when you, Kanasimi, can't for various reasons.

[1]: this is open source "plan". Plan are only true when they are done. So anyone who can do something it first can go ahead and propose some improvement.

Related issues

Late spring 2021

Summer 2021 / optional

hugolpz commented 3 years ago

Let's close this one. The boilerplate/kickstarter code have been seeded there: https://github.com/hugolpz/WikiapiJS-Eggs