Skip to content

Latest commit

 

History

History
41 lines (25 loc) · 1.58 KB

CONTRIBUTING.md

File metadata and controls

41 lines (25 loc) · 1.58 KB

Contributing to Prisma Documentation

We welcome all contributions to the Prisma docs! If you come across some documentation that you feel is missing or incorrect, please open an issue or submit a pull request.

I am not sure my changes are valid

If you are not sure your changes are valid, please open an issue and we will discuss it. Contributions from community members are welcome and will be considered for inclusion.

Creating an issue

There are no hard and fast rules for creating an issues to the repository. We only ask that you outline your reasoning for creating the issue and try to provide as much detail as possible. Depending on the issue, this could mean explaining what machine you are working on (Is it a Mac? Are you on a Windows machine?), or including a code snippet that demonstrates the issue.

Creating a pull request (PR)

We have a pull request template. The basic breakdown is as follows:

  • Describe the reason for the PR. A little context goes a long way in helping to quickly scan the PR
  • Briefly describe what changes were made
  • Link to any relevant issues

Add yourself to our contributors board!

This project follows the all-contributors specification.

To add yourself, include the following in your PR as a new comment:

@all-contributors please add @<username> for <contributions>

Where username is your github handle and contributions is any of the following:

  • bug
  • doc
  • example

A full example might look like the following:

@all-contributors please add @molebox for doc and example