kudzues/component-party
1
0
Fork 0
mirror of https://github.com/lainbo/component-party.git synced 2026-04-05 04:59:02 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md

Browse Source
This commit is contained in:
Mathieu Schimmerling
2022-05-19 17:54:56 +02:00
committed by GitHub
parent 27b41ffe7e
commit 7f46dc06ab
1 changed files with 18 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
CONTRIBUTING.md
View File

@@ -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.