From 24aea136fb00c6d079ae254e7d6fe35f5384128a Mon Sep 17 00:00:00 2001 From: OCDkirby Date: Fri, 6 Sep 2024 16:58:50 +1000 Subject: [PATCH] update CONTRIBUTING.md --- CONTRIBUTING.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b63dcee..0a8d42f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,9 +1,13 @@ # Contributing * [Fork the repo](https://github.com/RPCSX/rpcsx-site/fork) +* run `npm i` * Create a branch following conventions: `username-feature` * ex. `git checkout -b OCDkirby-titlebar` -* **IMPORTANT**: It's suggested that you read the comments in [vite.config.js](vite.config.js) to get a sense of the project structure. -* Commit changes and push the branch to your fork +* Make your changes + * It's suggested that you read the comments in [vite.config.js](vite.config.js) to get a sense of the project structure. + * Test your changes with `npm run dev` (hot reload supported) + * **IMPORTANT**: You MUST run `eslint --fix` or `npx eslint --fix` + * Commit changes and push the branch to your fork * Open a PR detailing your changes * Discuss edits with maintainers, if any