Please read this guide if you're interested in contributing to Traxion.
We welcome any form of contribution, especially from new members of our community 💚
Our community is a safe and friendly environment, where we support and treat each other with respect.
We invite you to actively participate in discussions on Github, and Discord.
You'll see many discussions about usage or design questions, but any topic is welcome. They are a great foundation to find potential issues, feature requests or documentation improvements.
To report a bug, you can use this template.
New bug reports require to be triaged. Oftentimes this includes creating a minimal reproduction, or verifying that the problem still occurs on the latest stable version or the unstable channel (see below).
When you're starting to look into fixing a bug, create a WIP PR that you mention in the original issue. This way, we ensure that everyone interested can share their thoughts, and duplicate work is prevented.
Adding tests is a great way to help prevent future bugs.
You can either improve existing content or add new resources.
If you miss particular information in the reference documentation, feel free to either create
To request a new feature, you can use this template.
To contribute features or API changes, it's best to start a discussion in an issue first, ideally with a proposal. This allows everyone to participate and ensures that no potential implementation work is in vain.
After getting some feedback, push to your fork and submit a pull request. We may suggest some changes or improvements or alternatives, but for small changes your pull request should be accepted quickly.
This content is adapted from the PRISMA Contributing Document and the Hapify Contributing Guidelines.