From 1e55884c948ac2157a177648dba64461b455b82d Mon Sep 17 00:00:00 2001 From: UsamaEquinorAFK Date: Tue, 14 Nov 2023 14:47:12 +0100 Subject: [PATCH 1/2] Add SECURITY.md --- SECURITY.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 SECURITY.md diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..1faac52 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,18 @@ +# SECURITY + +If you discover a security vulnerability in this project, please follow these steps to responsibly disclose it: + +1. **Do not** create a public GitHub issue for the vulnerability. +2. Follow our guideline for Responsible Disclosure Policy at [https://www.equinor.com/about-us/csirt](https://www.equinor.com/about-us/csirt) to report the issue + +The following information will help us triage your report more quickly: + +- Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.) +- Full paths of source file(s) related to the manifestation of the issue +- The location of the affected source code (tag/branch/commit or direct URL) +- Any special configuration required to reproduce the issue +- Step-by-step instructions to reproduce the issue +- Proof-of-concept or exploit code (if possible) +- Impact of the issue, including how an attacker might exploit the issue + +We prefer all communications to be in English. From c2d9fc0b502c088cf541bbe30291c395c362d1b8 Mon Sep 17 00:00:00 2001 From: UsamaEquinorAFK Date: Tue, 14 Nov 2023 14:47:26 +0100 Subject: [PATCH 2/2] Update README.md --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 6c97e7e..9350294 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,12 @@ Technically speaking, this package integrates to the API of [Energy Robotics](ht You need to have a user account on the Energy Robotics login portal which lets you create an API key. For authentication the email address of this user account is used as user name and the API key as password. +### Contributing + +We welcome all kinds of contributions, including code, bug reports, issues, feature requests, and documentation. The +preferred way of submitting a contribution is to either make an [issue](https://github.com/equinor/isar-exr/issues) on +GitHub or by forking the project on GitHub and making a pull requests. + ## Installation Clone and install in the repository root folder.