Hi there!
Since I never done anything in JS and wanted to create a module of my own to start this development, I created a module that fetches a random MTG (Magic The Gathering, for whoever is unfamiliar) card.
Link to repo: MMM-MTG Repository
I just created the first release which is compatible with MagicMirror v2.25.0. I haven’t tested any other versions but it doesn’t use any other dependancies.
Example:
Hi everyone,
After using the magic mirror software and 3rd party applications for a couple years now, it has come to my attention there’s a wide variety in how users and module publishers handle their module and Github repository. Also after Magic mirror software being updated, some repositories are obselete, and a new repo is created with the same name, but just a “2” or even “3” added to the module.
Sometimes I see people forking repositories, even adding their own features, but also falling behind the main repository.
I want to create a general discussion on how we, as a community, can improve this. As a software engineer myself, it kind of hurts to see that I have to search for multiple repositories because older ones are just obselete, but are created for the exact same functionality. Obviously sometimes someone wants to rework their code, so one part I understand it, but even then: Github has solutions for it.
For example, you can make releases, mark a specific commit and link it to a MagicMirror version. You can, afterwards, rework your entire code and make another release for, lets say, MagicMirror version 2.26.
Releases actually have automated changelogs that you can create. This will show the PR’s that are pushed between versions.
It is not a rant, as I know a bunch of people just make modules as a hobby project and are not software engineers as a main profession. But I do think some people are amazing at making software and integration of their API. So the knowledge is here, it just needs to be spread and people can learn from it.
How do you guys experience this? Especially in making modules. Do you actively monitor forks and request them making a PR with their added features?
Do you help people with issues, and do you implement new features so debugging or helping them is easier the next time?
Maybe people want to know more of a Github workflow so this can be easier for new 3rd party publishers.
Its all open for discussion here. Furthermore, I am willing to invest some time in a Github workflow or How-to guides if that is missing and needed (obviously I am not all-knowing, but I do know some stuff ;))
@sdetweil said in Github usage and module continuations:
yeh, I don’t think that will happen… we are a volunteer team, and have plenty of existing core issues to deal with… hundreds of additional modules just won’t be possible.
After seeing @KristjanESPERANTO list of modules, seeing that there are over a 1000, I think it is definitely not worth it to push everything to one repository. Especially with duplicates and/or obselete modules.
Although, seeing the list of “default” modules be extended with 3rd party “verified” modules with proper continues integration (tests / and build workflows so it gets automatically build with every software update) would be great.
@KristjanESPERANTO said in Github usage and module continuations:
I’ve started working on a new list of modules, and doing some rudimentary tests (you can see the result here). A few developers have already started work through the recommendations there. Even though the whole project is still in its infancy, but with that we have a process of assessing the quality of modules. Perhaps the whole thing will develop in the direction of module installer or app store. We will see. I would be delighted if you would take a look at the project and maybe join in.
I haven’t seen this yet, this looks pretty good. Awesome to see that there’s a different visual list to find modules and see when its last updated.
As I said in the starting post, it would be nice to have a general sense of direction on how to improve the entire module base and it gets easier and there’s more overview whats available. But also make it easier for people to develop their module and have it gain traction across the community.