Skip to content

VoronUsers Overhaul

Florian Heilmann edited this page Dec 19, 2023 · 5 revisions

Prologue

Hi, thank you very much for your PR.

First and foremost I would like to personally apologize for not being able to review your PR up until now. One of the main reasons for this was that the review process was very unoptimized and required a lot of man hours.

We have therefore decided to perform significant upgrades to VoronUsers:

  • A new automated check suite that should catch most of the common errors and provide detailed feedback to the user
  • No more modifying of the top-level README.md which was the main source of issues in this repo
  • Better integration with mods.vorondesign.com for better mod tagging and discoverability.

Unfortunately, this means that we cannot bring along the currently open PRs and would kindly ask you to resubmit your PR

My PR was just closed, what now?

I don't want to resubmit

We're sad to see your mod go, but understand that you may not want to update it and go through the hassle of resubmission. In this case, no further action is required from your side.

I'd like to resubmit

We would be very happy to receive your PR on the new and improved VoronUsers. In order to make your mod compatible with the changes, please perform the following actions:

  1. Make sure your mod respects the updated set of rules for submissions. Some notable changes are:
    1. All mods must include at least one CAD file
    2. Whitespace is not allowed in file/folder names
    3. Mods must follow the printer_mods/Author/mod_name folder structure. Please refrain from adding additional depths of folders, or putting your mod files directly in your author folder.
  2. Create a .metadata.yml file for your mod. Please find instructions here. This file replaces the changes to the top-level readme and allows you to specify name, printer compatibility, provided CAD files, images, etc.
  3. Sync your fork: Instructions to sync your fork can be found here. If you did not put your mod on a separate branch, you may encounter merge conflicts. The easiest approach to solve this is to delete your fork on github as well as your local file copy (don't forget to back up your mod files first) and start from scratch
    1. Fork the repo
    2. Check out a local copy of your fork
    3. Create a separate branch (i.e. not main)
    4. Add your files and commit
    5. Push
    6. Open a pull request
  4. Make sure your new PR targets the main branch. The old master branch will be retired soon and won't receive any updates

I have further questions or problems

Feel free to reach out in the #voronuser_mods channel on the VoronDesign discord. We have formed a dedicated group of users (you can ping them using the @GithubHelpers role) who are happy to assist you with any issues and will also provide feedback for your mod. Please note that during the transition we might not be as efficient as we would like to be.

Closing remarks

Once again I would like to thank you for your patience during this transition, and hope that the new and improved VoronUsers will help you share your mod with our community in a much easier and streamlined way!

-Haribro