diff options
author | 2023-03-22 18:38:19 +0100 | |
---|---|---|
committer | 2023-03-22 12:38:19 -0500 | |
commit | 58c612b746df4b0f489233c71e2aed3f2929acc8 (patch) | |
tree | ca3ff88b6eae89ec015c420641df524c62e9f2e7 | |
parent | 66e006028c56fd414fd14414d73bf534a5fd607b (diff) | |
download | astro-58c612b746df4b0f489233c71e2aed3f2929acc8.tar.gz astro-58c612b746df4b0f489233c71e2aed3f2929acc8.tar.zst astro-58c612b746df4b0f489233c71e2aed3f2929acc8.zip |
Add how to test changes section to CONTRIBUTING (#6581)
* Update CONTRIBUTING.md
* Add feedback to CONTRIBUTING.md
---------
Co-authored-by: Nate Moore <natemoo-re@users.noreply.github.com>
Diffstat (limited to '')
-rw-r--r-- | CONTRIBUTING.md | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3c0af74cb..347fd2e6d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -57,6 +57,22 @@ pnpm run dev pnpm run build ``` +**How can I test my changes while contributing to the repository?** + +During the development process, you may want to test your changes to ensure they are working as expected. Here are a few ways to do it: + +1. Run any of the examples in the `/examples` folder. They are linked to use the local Astro source code, so you can see the effects of your changes. + + ``` + pnpm --filter @example/minimal run dev + ``` + +2. Write a test and run it. This is useful if you're making a specific fix and want to see if your changes are working as expected. + +3. Create a separate project and use your local Astro through [`pnpm link`](https://pnpm.io/cli/link). This is helpful if you're making bigger changes and want to test them in a separate project. + +Overall, it's up to personal preference which method to use. For smaller changes, using the examples folder may be sufficient. For larger changes, using a separate project may be more appropriate. + #### Debugging Vite You can debug vite by prefixing any command with `DEBUG` like so: |