- Introduction
- Contributions Welcome
- Caveats
- Ground Rules
- How to Report a Bug
- Review Schedule
- Code Style
I'm still really new to maintaining open source projects. I won't attempt to write my own contribution guidelines from scratch. Instead these guidelines are lifted in part from @nayafia's contributing template.
First, I want to thank you. Both for your interest in this project and in improving it.
Following these guidelines will go a long way toward helping me to help you. Whether it's with usage issues, bug triage, or assessing and completing pull requests.
I focus a lot on improving the core of this project, and while I stay on top of the documentation, something is bound to escape my notice. If you want to write tutorials, examples, improve the existing docs, or even share some of the cool ways you use this project, I absolutely welcome that.
If you're an experienced functional programmer with suggestions on improving the source code, or willing to point out where I overdid it, I'd definitely appreciate your help.
Some contributions will be accepted or rejected on a case-by-case basis.
I'm not currently looking for feature requests as I have a solid idea of this library's intended features and architecture. Unless it's something the community demands and shows that it would improve the experience and workflow.
None of the above is really a hard rejection. I'm asking that you put a little more thought into why they would be necessary changes.
I understand that it's frustrating when software breaks, but open source maintainers—whether me or someone else—are not the real source of your ire. Nor are other members of the community who may try to help you.
Your issue is the problem. Respond accordingly.
Failing that, I have a Code of Conduct under active enforcement. And please don't hesitate to call out when my own behavior as a project maintainer sets a bad example. It's there for my words and actions as well.
Solving your issue will go much smoother if you follow this outline:
- Information about your environment (OS, Node version/browser)
- What you expected would happen
- What actually happened
- The error thrown by your console, if any
- The code that caused the issue, if applicable
- What you've already tried to resolve your issue
I usually check out the project for issues and pull requests on a weekly basis. Honestly, I'm not on the internet that much anymore, but I'll try to get to your bugs and contributions as quickly as I can. If it seems to be taking a while, you can email me at: [email protected] and give me a nudge.