Contributing to Miranum
We're excited to announce that our project is open to external contributors. We believe that collaboration is key to building great software and we welcome anyone who is interested in contributing to join us. If you're new to contributing to open source projects, we encourage you to check out our contributing guidelines. These guidelines will provide you with information on how to contribute to the project, including the process for submitting pull requests, contributing code, and reporting issues.
We also have a Code of Conduct that outlines the behavior we expect from all contributors to our project. We want to make sure that everyone feels welcome and comfortable contributing to our project, and our Code of Conduct helps us maintain a safe and inclusive community.
As an external contributor, you'll have the opportunity to make a real impact on our project. Your contributions could range from fixing bugs and adding new features to improving documentation and testing. We value all contributions and are committed to reviewing and merging contributions in a timely manner.
We believe that open source software benefits from a diverse set of contributors, and we welcome contributors from all backgrounds and skill levels. Whether you're a seasoned developer or just starting out, we believe that you have something to contribute to our project.
Thank you for considering contributing to our project. We look forward to working with you and building a thriving open source community. To engage with other contributors or just to join our lovely community, feel free joining our lovely Slack workspace.
As already mentioned, there are multiple ways how you can contribute to Miranum (e.g. bug fixes, documentation improvements, etc.). This section should help you understand the different repositories miranum consists of and which technologies they use.
We distinguish Miranum in four different repositories:
- Miranum-IDE: Contains all assets used by the Visual Studio Code plugins as well as the Miranum CLI, mostly written in TypeScript.
- Miranum-Connect: Contains the framework for building reusable integrations, written in Java.
- Miranum-Docs: Contains the documentation and guides. It is build with Docusaurus.
- Miranum-Consulting: Contains assets which enables users to get started with Miranum, like extensive examples.
To collect, prioritise and work on issues we have established a GitHub project. Following the link you can find all issues of the project. They are prioritised and hopefully well described. If you are interested in working on one make sure to assign yourself. Do not hesitate to ask any questions in the issue itself. The team is keen to help you.
In case you want to create a new issue, please do so via the issue-template in the repository your issue is targeted to.
We require an issue for every Pull-Request which is raised in one of the previously mentioned repositories.