We’re thrilled you’re here! Whether you’re fixing a typo, squashing a bug, or adding a shiny new feature, your help makes this package better for everyone. Let’s make collaboration fun and human!
Start a conversation
- Have an idea? We’d love to hear it! Open a discussion to chat about your proposal. Explain why it matters, and we’ll brainstorm together.
Keep it simple
- Small fixes? Jump right in! Fork the repo, make your changes, and send a pull request.
- Bigger changes? Let’s discuss it first in a discussion to align our ideas.
We’re here to help!
Stuck? Confused? Ask questions in the issue tracker—no judgment, just good vibes.
Code with kindness
- Write code that’s easy for humans to read (not just computers!).
- Keep methods short and focused—like a good coffee break.
- Add comments where things get tricky.
Tests are friends!
- If you’re adding something new, include a test to keep things safe and sound.
- We use PEST because it’s delightful. 🐝
Documentation matters
- Update the README if your change affects how folks use the package.
- Pretend you’re explaining it to a friend over tea. ☕
- Pull requests are gifts—wrap them nicely!
- Describe what you’ve changed and why.
- Link to related issues.
- We’ll review it with care and might suggest tweaks (it’s a team effort!).
- Celebrate when it’s merged! 🎉
This is a space for kindness, curiosity, and respect. Assume positive intent, give constructive feedback, and celebrate each other’s wins. We’re all here to learn and grow together!
Seriously—thank you for giving your time to this project. Open source thrives because of humans like you. Let’s make something great together!
P.S. These guidelines were inspired by Spatie’s open-source spirit. Need help? Just ask!