From 5761ffcf5b5c663c9e1bcc98b9222a6ba2faa2a1 Mon Sep 17 00:00:00 2001 From: Tim Koch Date: Mon, 16 Sep 2024 17:55:48 +0200 Subject: [PATCH] Run dev before editing Again, purely personal opinion. I think first making the environment run before editing is the more natural way. For example, it reassures the contributor that everything works BEFORE the editing. If you like the other order more, feel free to drop this commit! --- CONTRIBUTING.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2411641..89ec48f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -21,11 +21,7 @@ Follow these steps to set up Astro with Starlight and additional extensions: - [Astro](https://marketplace.visualstudio.com/items?itemName=astro-build.astro-vscode) - [MDX](https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx) -5. **Create your contribution** - - Either edit a markdown file in the `src/content/docs/` directory or create a new `.mdx` file in the `src/content/docs/` directory and start writing your docs article. - -6. **Run your Astro site** +5. **Run your Astro site** Start the development server by running the following command inside the local repository: ``` @@ -33,6 +29,11 @@ Follow these steps to set up Astro with Starlight and additional extensions: ``` This will start a local server and give you a URL to preview your changes. +6. **Create your contribution** + + Either edit a markdown file in the `src/content/docs/` directory or create a new `.mdx` file in the `src/content/docs/` directory and start writing your docs article. + + 7. **Create a Pull Request** Create a new pull request from your forked repository to the main documentation-coolify repository.