Merge pull request #24 from taxepfa/icflorescu-patch-2

Create CONTRIBUTING.md
taxepfa · Oct 6, 2023 · 417f3f0 · 417f3f0
2 parents c36b367 + ae52337
commit 417f3f0
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/CONTRIBUTING.md 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.