From 7f46dc06ab7053e41c466ccdbdd3f2b399ef22c9 Mon Sep 17 00:00:00 2001 From: Mathieu Schimmerling Date: Thu, 19 May 2022 17:54:56 +0200 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0bd2144..d7cffb3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,22 @@ -# Contributing +# 🧑‍💻 Contributing -## Building +This site is built with [Astro](https://docs.astro.build). Site content is written in Markdown format located in `content`. For simple edits, you can directly edit the file on GitHub and generate a Pull Request. + +## Add a framework + +1. Fork the project and create a new branch +2. Add the new framework SVG logo in `public/framework` +3. Install the ESLint plugin associated to the framework +4. In `src/frameworks.mjs`, add a new entry with SVG link and ESLint configuration + + +## Improve website + +For local development, [pnpm](https://pnpm.io/) is preferred as package manager: ```bash -pnpm run build +pnpm i +pnpm run dev ``` + +This project requires Node.js to be `v14.0.0` or higher, because we use new JavaScript features in our code, such as optional chaining.