Welcome!
We'd love to have your contributions to the Spyderisk Adaptor. This document is about our practical principles of working.
The overall Spyderisk aim is to:
understand the trustworthiness of socio-technical systems by establishing an international Open Community supporting the research, development, use and support of open, effective, and accessible risk assessment methods, knowledge and tools.
You can read more about this in the general Spyderisk description, which explains who we are and who Spyderisk is intended for.
Please read our Code of Conduct to keep our community approachable and respectful.
This Adaptor Project is about the service that offers a higher-level API to the risk reasoner in the Spyderisk System Modeller. You might just be wanting to deploy it (using the Docker images provided) or to make changes to the Python code. Plus of course we welcome fixes to the documentation.
Do please drop us an email to team@spyderisk.org or open a discussion issue on GitHub.
You should follow the Adaptor README to setup a Docker instance
of the service, and try out some simple API calls starting from the
tests/examples. As you explore what we have done you'll be able to see
what needs work.
Alternatively you can find an issue from our List of open Adaptor Issues, or just create a new query or bug report as described in the following section.
Whatever you decide to work on, follow the "How to submit a patch" procedure below
- Open a new issue in system-modeller-adaptor
- Select the template marked "New Spyderisk Adaptor query", or "New Spyderisk Adaptor bug report"
You are about to make us very happy. There are several cases:
- Documentation fix - create a fork and send a pull request
- Obvious code fix - create a fork and pull request, just as for documentation
- Any other code fix - please create a query or bug report according to the previous section. It may well be that you have code which is good to go, but in our young open project there is a lot of context that might be relevant to what you wish to do.
But basically just talk to us using whatever means you are comfortable with, and we will figure it out.
- Our software licensing is Apache 2, and analogously for documentation
- Our communication is collaborative and collective
- We build our software around openly published academic theory
Spyderisk needs to be both trustable and also to progress quickly. Where there is incomplete or inaccurate work in the Spyderisk Adaptor code then we document this with the string:
WIP: BRIEF TEXT DESCRIPTION, https://github.com/Spyderisk/system-modeller-adaptor/issues/NNN
Where "BRIEF TEXT DESCRIPTION" should not exceed a couple of sentences, and NNN should be the most relevant issue.