👋
Thank you for reading this file! We'd love to see you help us make this package even better than it is. Since we are all working on Kayu in our free time, it's important that we follow some set of guidelines to make communication easier. Read this guideline to learn what we have in mind.
Generally, people are very smart. I am smart, you are smart, everyone here is smart. As a rule of thumb, try to understand what the other person is saying even if it doesn't make any sense. It's highly probable that they just don't know how to explain their (actually) very good idea.
Very short; check the docs first, check discussions second, sleep on your problem than open an issue. It's a lot more beneficial if you find a workaroudn and share it than opening up an issue and complaining about it.
And you'll feel great, I promise.
Alright, so you want a new feature, right? Me too! Everyone wants a new feature - a little something that would solve their small (or big) problem. Unfortunatelly, literally everyone wants a feature.
This is a community driven project. Nobody is paid to work on it. Keep that in mind at all times.
To save people working on Kayu some time, first check other issues and discussions to see if somebody has requested a similar feature. It's a lot easier for us to prioritise tasks and implement a feature if we see a flourishing discussion in one of the feature requests. Share your thoughts, do research.
We are inclined to read well structured arguments. If your request hasn't received much attention in say a month, try to do some research on it and share your findings. The more knowledge there already is, the easier (and faster) your feature will be implemented.
When submitting a pull request, it's important that you correctly label your change. Does it fix something? Does it introduce something new? Breaks something?
We use semantic versioning. You can read more about it here. When creating pull requests, try to follow the semantic versrioning spec or explain how your changes affect the code. Do they break anything? Is this a fix?
Don't feel discouraged by all the things you have to learn. You can do it. This is a slowly evolving library, we want to get it right.
Thank you! You made this library a lot better than it was. ❤️
Oh cool! We love examples. Create a folder in examples that contains your example, and name it <name>-demo. Check out existing examples for more guidance!
You'll need yarn. Run yarn install to install everything, and you might have to run yarn build in packages/nookies and yarn again to get the examples working.