Submiting your ideas / packages

[pi0]

Hi! You are here probably since you have an idea or want to submit your package being hosted as part of UnJS ecosystem. That's awesome! ❤️

First of all, I invite you to read this guide to know more about how UnJS is governed.

TLDR, UnJS is an (opinionated) collection of various packages by me @pi0 and more people that aim to make high-quality and reusable JavaScript solutions easy for everyone. Sometimes they are new ideas, sometimes they are a modernized version of that is already there sometimes a rework to make the "perfect" version. There is no boundary and at the same time this collection is heavily well thought about what and how in them. And these tools belong to everyone in JS ecosystem. We run to be neural as much as we can.

Overtime I met amazing talented people (@danielroe @antfu but many more not fitting in a list!) that have amazing ideas and it would be just silly to keep this collection limited to one person. So the doors are open. When a project is fitting with what i feel same and aligned, they are welcome and remain maintained by their original author the way they see fit.

When it comes to adding even more projects to this ever-growing collection, i have to emphasise again how much thought is put to decide what is included and what is not while there is not a general filter to define the criteria. It happens often when we need something. Sometimes i keep hold of my personal ideas for months before finally decide to add them or cancel them. UnJS should grow but as it grows, comes more responsibility. I don't want to make a tall tower of solutions that finally falls apart and even considering to remove some of my older ideas from this collection as the same time of writing this because some are essentially replaced by new ideas in UnJS or outside or not making sense any more (JS world is amazing!)

Because the nature of how this collection is made and how JS ecosystem changes day by day, i cannot make a criteria list nor making something like a pool would help the consistency and vision. JS can be super opinionated sometimes and there is no one answer. Each idea should be handled case-by-case thoroughly. Usually things like:

• Is this solution really needed particularly in UnJS?
• Can this solution be merged to one of other UnJS projects or ideas?
• Can this solution be made differently?
• (and so on...)

How to build projects to be compatible with UnJS

There is really no rule. But here is roughly a quick draft of what i do for making one package:

• Thoroughly research across UnJS and NPM about alternative ideas
• Is it mergeable to another project/idea? If not what makes it unique?
• Is it benefiting enough amount of usecases or too specific?
• Find a package name (1) that is describing idea
• Use unjs template or similar alternative tools that allow making universal modern JavaScript code out of it
• Design the API to be minimal, general and extendable
• Publish your package when feel ready to go, and try to gather community feedback (sharing with other projects that might benefit, X, Reddit, etc).

(1) While UnJS does not own un* prefix and always you can use them as long as available, it is conventional for us to use this prefix. Please please please try to avoid this prefix even if you aim for your idea to be finally part of UnJS. This helps to keep as placeholder reserved for future ideas and not confusing people.

How can i submit my idea/project

At the same time (before or after publish) feel free to contact me via a private channel (Discord @pi0 Email pooya at pi0 io X: _pi0_) and share your higher vision summary of idea. I would be more than happy to have a chat to share feedback, ideas and also if there is already a plan in UnJS that is related to them so you can decide either join the efforts or not to.

Finally and lastly, if you ideas is concluded to be not fitting, please don't be discouraged. Your idea is certainly amzing and it might be due to either conflicting vision, lack of my knowledge or just having them too early that not get accepted. Even if they don't fit today, not only i but I'm sure rest of UnJS team would be happy to help you on the journey, but also it might be later become a fitting idea. JS ecosystem changes day by day and nothing is certain.

Thanks!