Thank you for considering contributing to hashnode-next. Your contributions are highly valued and appreciated.
- 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
The development branch is main
. This is the branch that all pull
requests should be made against.
To develop locally:
-
Fork this repository to your own GitHub account and then clone it to your local device.
-
Create a new branch:
git switch -c MY_BRANCH_NAME
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.
pnpm install
If you need to add or update the Hashnode GQL schema, run the following command to generate types and gql documents.
pnpm hashnode-codegen
pnpm build
pnpm format
pnpm lint
If you get errors, be sure to fix them before committing.
- Be sure to check the "Allow edits from maintainers" option while creating your PR.
- If your PR refers to or fixes an issue, be sure to add
refs #XXX
orfixes #XXX
to the PR description. ReplacingXXX
with the respective issue number. See more about Linking a pull request to an issue. - Be sure to fill the PR Template accordingly.