Merge branch 'dev' into dhruv/2091/updating-tutorials

Author: PepperLola

.github/workflows/FissionBiome.yml

@@ -38,11 +38,11 @@ jobs:
         if: ${{ always() }}
         run: |
           cd fission
-          bun run lint && echo "Biome Linting Validation Passed" || (echo "Biome Linting Validation Failed" && exit 1)
+          bun run lint --diagnostic-level=error
 
       - name: Format
         id: format-validation
         if: ${{ always() }}
         run: |
           cd fission
-          bun run fmt && echo "Biome Formatting Validation Passed" || (echo "Biome Formatting Validation Failed" && exit 1)
+          bun run fmt

.github/workflows/FissionUnitTest.yml

@@ -11,7 +11,7 @@ jobs:
   runUnitTests:
     name: Playwright Unit Tests
     container:
-      image: mcr.microsoft.com/playwright:v1.54.0-noble
+      image: mcr.microsoft.com/playwright:v1.54.2-noble
     runs-on: ubuntu-latest
     defaults:
       run:
@@ -56,4 +56,42 @@ jobs:
         run: npm install
 
       - name: Run Tests
-        run: HOME=/root npm run test
+        run: HOME=/root npm run test --bail=1
+
+  runAssetpackTests:
+    name: Assetpack Tests
+    needs: runUnitTests
+    container:
+      image: mcr.microsoft.com/playwright:v1.54.2-noble
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: "fission"
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+      - name: JavaScript Setup
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Cache Unzipped Synthesis Assets
+        id: cache-assets
+        uses: actions/cache@v3
+        with:
+          path: fission/public/Downloadables
+          key: ${{ runner.os }}-assets-${{hashFiles('fission/public/assetpack.zip')}}
+
+      - name: Cache Node Dependencies
+        uses: actions/cache@v3
+        with:
+          key: "${{runner.os}}-npm-fission-${{hashFiles('fission/package.json')}}"
+          path: "fission/node_modules"
+          restore-keys: |
+            ${{runner.os}}-npm-fission-
+            ${{runner.os}}-npm
+
+      - name: Run Assetpack Tests
+        run: HOME=/root npm run test src/test/mirabuf/DefaultAssets.test.ts --bail=1
+        env:
+          VITE_RUN_ASSETPACK_TEST: true

CONTRIBUTING.md

@@ -2,50 +2,71 @@
 ![Synthesis: An Autodesk Technology](/engine/Assets/Resources/Branding/Synthesis/Synthesis-An-Autodesk-Technology-2023-lockup-Wht-OL-No-Year-stacked.png#gh-dark-mode-only)
 
 # Synthesis Contribution Guide
-Synthesis is 100% open source and relies on the FIRST community to help make it better. The Synthesis Contribution Guide suggests ways in which you can get involved through development and non-development avenues. 
+
+Synthesis is 100% open source and relies on the FIRST community to help shape its growth. The Synthesis Contribution Guide suggests ways in which you can get involved through development and non-development avenues.
+
+# How to Contribute
+
+Before you contribute to this repository, please first discuss the change you wish to make a GitHub issue or reach out through our [community Discord](https://www.discord.gg/hHcF9AVgZA). This way we can ensure that there is no overlap between outside contributors and internal development work.
+
+When ready to contribute, fork the Synthesis repository, make your changes, and submit a pull request. When contributing to Synthesis, please branch from and submit to our `dev` branch. The `prod` branch is intended to be a copy of either exactly what is in production, or what is ready for production. We like to keep changes to the dev branch so they have time to simmer and be distributed via beta releases.
+
+Be sure to fill out the pull request template accordingly to make reviewing your work as smooth as possible.
 
 # Why Contribute? Benefits to Contributing
-* Prepare for an internship - share your contributions when applying to the [Synthesis Summer Internship.](https://synthesis.autodesk.com/internship.html)
-* Add your contributions to Synthesis: An Autodesk Technology to your portfolio
-* Meet other members of the FIRST community
-* Get involved and learn more about Autodesk products
+
+- Prepare for an internship - share your contributions when applying to the [Synthesis Summer Internship.](https://synthesis.autodesk.com/internship.html)
+- Add your contributions to Synthesis: An Autodesk Technology to your portfolio
+- Meet other members of the FIRST community
+- Get involved and learn more about Autodesk products
+- Improve a product that you care about - if you use Synthesis and notice a feature you want, get involved!
 
 # How to Contribute
+
 ### Found a bug? Have an idea for a feature?
+
 Please [contact us](#Contact-Us) to let us know about the issue or feature!
 
-*A Note to Developers*: When contributing to this repository and making large changes, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change. This  way, we can ensure that there is no overlap between contributions and internal development work. You may contact us using any of [these methods](#Contact-Us), although email is preferred in this case.
+_A Note to Developers_: Please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change. This way, we can ensure that there is no overlap between contributions and internal development work. You may contact us using any of [these methods](#Contact-Us), although email is preferred in this case.
 
-For smaller changes, just submit a pull request and be sure to include a clear and detailed description of the changes you've made so that we can verify them and eventually merge.
+For smaller changes, just submit a pull request and be sure to follow the PR template to create a clear and detailed description of the changes you've made.
 
 ### Submit a CAD Model
+
 Submit your team's CAD model to be added to the Synthesis robot and field libraries by emailing your designs to frc@autodesk.com. Please share them in the form of a Fusion360 Share-link. Raw Mirabuf files will not be accepted.
 
 ### Write Tutorials, Increase Documentation
-We are always interested in ways to make our tutorials and documentation more clear to our end users. If there is content missing or could be refined, please follow our [contribution guidelines](#How-to-Contribute) for submitting a change.
+
+We are always interested in ways to make our tutorials and documentation clearer for our end users. If there is content missing or could be refined, please follow our [contribution guidelines](#How-to-Contribute) for submitting a change.
 
 ### Translate our Tutorials and Documentation
+
 If you or someone you know can read and write in another language, we would like to translate our text-based resources to make them available in more languages. Contact frc@autodesk.com for more details.
 
 ### Create How-To or Project DIY and Inspiration Guides
+
 Did you add a feature to Synthesis, or learn how to use a specific feature? Write a how-to guide or [share your project with us](#Contact-Us).
 
-### Share a Use Case Story
-Hearing how you use Synthesis is valuable feedback to our team. Share your stories by tagging us [@synthesis.adsk](https://www.instagram.com/synthesis.adsk/) on Instagram, posting on [ChiefDelphi](https://www.chiefdelphi.com/), or talking about it on [Discord](https://discord.gg/FuuQ9UGycM).
+### Share Your Use Case
+
+Hearing how you use Synthesis is valuable feedback to our team. Share your use cases by tagging us [@synthesis.adsk](https://www.instagram.com/synthesis.adsk/) on Instagram, posting on [ChiefDelphi](https://www.chiefdelphi.com/), or talking about it on [our Discord](https://discord.gg/FuuQ9UGycM).
 
 ### Expand FIRST Support
+
 FIRST control systems and essentials like sensors, cameras, various motors, etc. would greatly increase simulation support. Learn more about [contributing development here](#How-to-Contribute).
 
 ### Beta Testing
+
 Help us try and break Synthesis! At the end of summer development, we provide a Synthesis beta for users to test and sometimes in exchange for your time we offer incentives to users. You can stay up-to-date with any Synthesis releases by joining our [Discord server](https://www.discord.gg/hHcF9AVgZA) and/or following us on Instagram [@synthesis.adsk](https://www.instagram.com/synthesis.adsk/).
 
 ### Contact Us
-| Platform | Link |
-| :--- | :---: |
-| Discord     | [Synthesis Community Discord](https://discord.gg/FuuQ9UGycM)           |
-| Email       | [frc@autodesk.com](mailto:frc@autodesk.com)                            |
-| Instagram   | [@synthesis.adsk](https://www.instagram.com/synthesis.adsk/)           |
-| Reddit      | [u/synthesis_adsk](https://www.reddit.com/user/synthesis_adsk/)        |
+
+| Platform    |                                  Link                                  |
+| :---------- | :--------------------------------------------------------------------: |
+| Discord     |      [Synthesis Community Discord](https://discord.gg/FuuQ9UGycM)      |
+| Email       |              [frc@autodesk.com](mailto:frc@autodesk.com)               |
+| Instagram   |      [@synthesis.adsk](https://www.instagram.com/synthesis.adsk/)      |
+| Reddit      |    [u/synthesis_adsk](https://www.reddit.com/user/synthesis_adsk/)     |
 | ChiefDelphi | [synthesis_adsk](https://www.chiefdelphi.com/u/synthesis_adsk/summary) |
 
 To let us know about an issue with Synthesis, you can submit a [GitHub issue](https://github.com/Autodesk/synthesis/issues/new/choose).