Skip to content

Latest commit

 

History

History
66 lines (43 loc) · 2.17 KB

CONTRIBUTING.md

File metadata and controls

66 lines (43 loc) · 2.17 KB

Contributing to hashnode-next

Thank you for considering contributing to hashnode-next. Your contributions are highly valued and appreciated.

The basics

  • Before submitting a new issue or PR, check if it already exists in issues or PRs.
  • If there isn't an issue please create one before any development begins
  • If you're working on an issue, please comment on it so that others know you're working on it

Developing

The development branch is main. This is the branch that all pull requests should be made against.

To develop locally:

  1. Fork this repository to your own GitHub account and then clone it to your local device.

  2. Create a new branch:

    git switch -c MY_BRANCH_NAME

Installing

hashnode-next uses NVM and PNPM for package management.

To set the correct version of PNPM, run nvm use from the root. There is a .nvmrc file that controls the correct node version.

Installing dependencies

pnpm install

Hashnode GQL codegen

If you need to add or update the Hashnode GQL schema, run the following command to generate types and gql documents.

pnpm hashnode-codegen

Building

pnpm build

Linting

pnpm format
pnpm lint

If you get errors, be sure to fix them before committing.

Making a Pull Request