Contributions guide #

Thanks for your interest in contributing! Please make sure to take a moment and read through Prisma-AppSync concept, as well as the following guide:

👉 Repository setup #

We use pnpm as the core package manager, yarn and docker for creating the AWS CDK bundle before deployment, zx for running scripts, aws and cdk CLIs for deployment.

Start with cloning the repo on your local machine:

git clone https://github.com/maoosi/prisma-appsync.git

Install pre-requirements:

Verify installation:

node -v && pnpm --version && yarn --version && zx --version && docker --version && aws --version && cdk --version

Install dependencies:

pnpm install

Run local dev playground:

pnpm dev

See list of commands below for more details about pnpm dev.

👉 Commands #

[1] Automatically generates a playground folder (unless already existing), plus run a local GraphQL + AWS AppSync server pointing to the playground folder. This creates an ideal local dev environment that emulates Prisma-AppSync running on AWS locally. Everything inside playground is pointing local source packages.

👉 Sending Pull Request #

Discuss first #

Before you start to work on a feature pull request, it's always better to open a feature request issue first to discuss with the maintainers whether the feature is desired and the design of those features.

Commit convention #

We use Conventional Commits ↗ for commit messages such as:

<type>[optional scope]: <description>

• Possible types: feat / fix / chore / docs
• Possible scopes: client / generator / cli / boilerplate / server
• Description: Short description, with issue number when relevant.

Here are some examples:

👉 Coding guidelines #

ESLint #

We use ESLint ↗ for both linting and formatting.

{
    "editor.codeActionsOnSave": {
        "source.fixAll": false,
        "source.fixAll.eslint": true
    }
}

No Prettier #

Since ESLint is already configured to format the code, there is no need to duplicate the functionality with Prettier. If you have Prettier installed in your editor, we recommend you disable it when working on the project to avoid conflict.

👉 Legal #

By submitting your code to the Prisma-AppSync project, you are granting the project maintainers a right to use that code and provide it to others under the BSD 2-Clause License attached to the project. You are also certifying that you wrote it and that you are allowed to license it to us.