Contributor Guide
If you are you looking to contribute to Morio, or want to learn more about it, this guide is a good starting point.
This is a high-level overview, with links to more detailed info. We’ll cover the following topics:
Governance
Morio is a project by CERT-EU, the Cybersecurity Service for the Institutions, Bodies, Offices and Agencies of the European Union. It is CERT-EU’s management under supervision of the EU’s Interinstitutional Cybersecurity Board (), who have the final say on all things CERT-EU, including Morio.
The day to day management of the project is in the hands of CERT-EU’s engineering team.
To learn more about CERT-EU or the IICB, consult this summary on EUR-Lex:
License
Morio uses the EUPL license, an OSI-approved free software license that exists to encourage a new wave of public administrations to embrace the Free/Open Source model to valorise their software and knowledge [source]
When you contribute to Morio, those contributions shall also be licensed as EUPL.
Code of Conduct
Our code of
conduct is a
verbatim copy of the Contributor Covenant v2.1.
The only change made are the insertion of CERT-EU’s contact details.
As a Morio contributor, you must respect and uphold this code of conduct.
Source Code
The Morio source code is hosted on GitHub at certeu/morio.
A read-only mirror is available under the same path at
code.europa.eu, a GitLab instance for
open source projects by (the administration of) the European Union.
We use a , which holds all the code for the Morio project.
Contributions should be made as pull requests against the develop branch.
To learn more, refer to the monorepo guide.
Documentation
The Morio documentation is (also) hosted in the certeu/morio repository on
GitHub, specifically in the docs/docs folder.
To learn more, refer to the documentation guide.
Help & Feedback
Run npm run help in the root for pointers on how to get help.
The output will resemble this:
_ _ _ ___ _ _ _ ___
| ' ' |/ . \| '_/| |/ . \
|_|_|_|\___/|_| |_|\___/
Need a little hand? No worries, you're not alone.
Morio is under active development and currently in alpha.
Some things might be broken, or simply not implemented yet.
But we value all contributors, and want this to be a pleasant
experience for you. So if you are stuck, please let us know
because it is unlikely you are the only one facing issues.
Here's some ways you can reach out to the people behind Morio:
- Morio Documentation: https://morio.it/
Have you read the fine manual (RTFM)?
We work really hard on our documenation so we want you to read
it. Not just to learn, but also to tell us how we can do better.
- GitHub Discussions: https://github.com/certeu/morio/discussions
If your question is not answered by teh documentation, do not
hesitate to create a question here.
This has the benefit of being public, so once a question is
answered, others can read it, or can find it via Google.
- GitHub Issues: https://github.com/certeu/morio/issues
If you feel it's not really a question but more of a problem
report -- and you have considered the fact that Morio is in
alpha right now -- you can create an issue. Which is like a
ticket if you will. Note that this too will be publicly
accessible.
- Contact us
If you have an SLA with CERT-EU, please use the
usual channels for your inquiry.
If not, and you have considered the options above and they do
not work for you for some reason, you can contact us directly.
However, please keep in mind that this does not scale very well,
and you are relying on people's free time to help you.
That being said, you can reach out to the Morio maintainer, joost:
- Mastodon: https://freesewing.social/@joost
- Email: joost@joost.at
And remember to not get discouraged.
Nobody knows everything.
But together, we may be able to figure it out.