Background

I recently have went through the process of drafting a UMIP for the first time and while I have an appreciation for the importance of the process, I ended up frustrated, and it took me longer than anticipated.

There is a lot that goes into getting the content together, making sure the format is correct, as well as some of the workflows for uploading it to github, and submitting a pull request in order to get it into the UMA/UMIP repository.

As UMA continues to grow and we engage with other interested communities, the need to write UMIPS will grow with that. I wanted to provide a centralized place to share my lessons learned and some of the basics that are required to work through this process.

<aside> 💡 I am still relatively new at this process, so at any point would welcome feedback, revisions, and additions to this content to make it valuable to the UMA community.

</aside>

UMIP Content Creation

The first thing you want to make sure you understand is the goal and the content of the UMIP that you are drafting. There are a handful of different types of UMIPs and depending on that, you may need to include somewhat different content.

Two common examples are below with linked templates to follow:

This video is a little long at ~30 mins, but Clayton and Sean from the UMA team do a great job explaining what content goes into an UMIP. They talk through each section and give some explanation and it was very helpful in putting together the iFARM drafts for Harvest.

https://www.youtube.com/watch?v=4kDVMJywaQE

After you have looked at the above, if you are still stuck, reach out! There are a lot of willing helpers in the SuperUMAn community and on the UMA team. The #wen-options channel in the UMA Discord server is a great place to ask.

Format of the UMIPs

Once you have a good idea of your content, you want to make sure your format is correct. All UMIPs need to be in Markdown format- If you are not familiar with that, here is a quick summary and a couple resources to learn more: