diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..416181f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,14 @@ +# Contributing + +This is a SSG React/Next.js application written in TypeScript. +It uses the outstanding Mantine UI framework and Valtio for state management. +I expect you to know of these things if you're planning to contribute. + +## Important + +Pushing to the `main` branch triggers a GitHub workflow, so make sure to target your PRs to the `dev` branch. + +## Running in development mode + +Required Node.js > 18 & `yarn`. +Run `yarn dev` in the project folder.