Contributing Guide

Want to get involved with Iridium's development? That's great and any support of the project is hugely appreciated. You'll get a mention in our CONTRIBUTORS.md file with a link to your Github for any sized contribution.

There are two routes for your involvment with the project.

1. Working on Iridium directly
2. Creating a Iridium plugin

Iridium maintains an internal roadmap for features for V1 & beyond. If you want to get involved with it's core development, or suggest new features, please see here (coming soon).

If you have a particular idea for what features Iridium could provide to end users, but it's better suited for a plugin that's awesome too! Feel free to share your suggestions with the community or start working on it yourself. Community plugins will have their own showcase on plugins.iridiumgo.dev (coming soon).

Contributing Recommendations

Have a particular skill set you feel you could lend to the project?

• Want to work on CSS/tailwind?
  • Our style sheets could likely be cleaned up & streamlined. Adding in new data-attributes for different display options for forms, resources, tables, would be a huge help as well.
• Do you speak a language other than english fluently?
  • Reviewing our auto-translated language files to make sure Iridium is clear in your native language would be an awesome help.
• Want to work on a core feature?
  • Feel free to review the roadmap and give it a go!
• Want to help test Iridium?
  • Iridium is currently under tested in it's pre-alpha phase. Writing more unit, integration, & UI tests is always appreciated.
• Want to help with Iridium's design, docs website, or landing page?
  • Right now our doc & landing page are written in Vue. Moving these to a go + templ site with consistent styling with Iridium itself its likely too large a project to get started with Iridium's development. It is something in the roadmap way off in the future.

Using A.I.

The vast majority of Iridium's code was handwritten by it's creator. However, in specific sections A.I. was used, particularly for CSS.

• We're not 100% anti-A.I. and if you use A.I. to contribute, that is acceptable, so long as you review and validate all of its output yourself.
  • If you can not validate your A.I. generated code yourself, we ask you spend additional time understanding what it is you're contributing before sharing it with us.
• You're free to use as much or as little A.I. in your custom plugins however.

Entirely A.I. generated submissions will be auto-rejected by maintainers.