From 979cb1d5e5b9214bef9f39c1abfd9c2e8569dd2a Mon Sep 17 00:00:00 2001 From: Ariful Alam Date: Sat, 23 Jul 2022 15:03:51 +0600 Subject: [PATCH] Update contributing guide --- CONTRIBUTING.md | 15 ++++++++------- README.md | 2 +- 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a767683..068ff8b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,40 +12,41 @@ If you find a bug in the source code or a mistake in the documentation, you can submitting an issue to our [GitHub Repository](https://github.com/arifszn/awesome-shortcuts/issues/new). Even better you can submit a Pull Request with a fix. -### Developing +## Developing -Fork, then clone the repo: +Fork the repo and clone it. ```sh git clone https://github.com/your-username/awesome-shortcuts.git + cd awesome-shortcuts ``` -Install dependencies: +### Install dependencies ```sh npm install ``` -Run dev server: +### Run dev server ```sh npm start ``` -Build website: +### Build website ```sh npm run build ``` -Build chrome extension: +### Build chrome extension ```sh npm run build:extension:chrome ``` -Build firefox extension: +### Build firefox extension ```sh npm run build:extension:firefox diff --git a/README.md b/README.md index c920aba..ba45222 100644 --- a/README.md +++ b/README.md @@ -173,7 +173,7 @@ ## Contributing -To contribute, see the [Contributing guide](https://github.com/arifszn/awesome-shortcuts/blob/main/CONTRIBUTING.md). +To contribute, see the [contributing guide](https://github.com/arifszn/awesome-shortcuts/blob/main/CONTRIBUTING.md). ## License