Please read this guide if you're interested in contributing to Prisma.
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, the Forum and Slack.
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 preventing future bugs.
You can either improve existing content or add new resources.
If you miss a particular information in the reference documentation, feel free to either create an issue or PR. We also welcome tutorials for related topics that you're interested in. If you come across an interesting pattern, feel free to add a new example to our example list!
Running against the unstable channel in your development or staging environment is a great way to help out. This way you can benefit from features before they are released on the stable channel, and help detect bugs or performance issues.
Note that when running the unstable channel, you might encounter unexpected behaviour.
Therefore, make sure to run a local backup using prisma export before, to stay on the safe side.
Checking out the unstable channel locally is as easy as this:
npm install -g prisma@beta
prisma local upgrade
Let us know if you encounter any problems on the unstable channel or help improving the documentation for upcoming features!
To request a new feature, you can use this template.
To contibrute features or API changes, it's best to start a discussion in an issue first, ideally with a propopal. 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.
Here are further contribution instructions:
Below are a series of steps to help you from a more "practical" perspective. If you need additional help concerning Git, Github has some great guides that you may want to check out! Check them out here
Fork the repo and then clone your fork
SSH:
git clone git@github.com:YOUR_USERNAME/prisma.gitHTTPS:
git clone https://github.com/YOUR_USERNAME/prisma.gitAdd the remote upstream
git remote add upstream git://github.com/graphcool/prisma.gitFetch changes from upstream
git fetch upstreamPull changes locally
git pull upstream masterPush changes up
git push