Contributing Guide

Want to get involved with Iridium's development? That's great, and any support of the project is hugely appreciated!

There are two routes for your involvement with the project.

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

Iridium maintains an internal roadmap for features for V1 & beyond. If you want to get involved with its 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 our website here.

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, and 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 its 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 is likely too large a project to get started with Iridium's development. It is something in the roadmap way off in the future.

Contribution Rules

Please treat all contributors & maintainers with respect. We are all adults. We all make mistakes. Treat your engagement with this project the same as you would your professional life.

100% of your contributions will be credited to you.

AI & AI-Generated Content

Fully AI generated pull requests or feature requests will be rejected.

To be politely firm, there is no reason for this project to accept submissions generated entirely by AI. If the maintainers wanted AI-generated output, we are capable of generating it ourselves.

This project values your opinions and ideas, from your own experiences, and originating from your mind. Those are things AI cannot replace, and they are what make contributions genuinely useful. We are incredibly grateful should you choose to lend your own voice to the project.

If you choose to use A.I. to assist your contributions, that is your prerogative, so long as you understand and audit what it has generated for you, before submitting it.