Skip to content

Commit

Permalink
add contributing.md and security.md
Browse files Browse the repository at this point in the history
  • Loading branch information
equinor-ruaj committed Nov 27, 2023
1 parent 368f608 commit d1cbd5b
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 0 deletions.
28 changes: 28 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# How to contribute to this repo

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

- Reporting a bug
- Proposing new features
- Discussing the current state of the code
- Submitting a fix

This is how you should do it:

Use our [issue list](../../issues) to report a **bug** or **propose a new feature**, including

### Reporting a **bug report**
- A quick summary and/or background
- Steps to reproduce
- What actually happens

### Adding a **feature request**
- Brief description of the feature
- What problem/issue will this solve
- A sort of Definition of Done - "How should it look when finished"

### When submitting a fix using a Pull Request (PR)
- Fork this repository from GitHub
- After you have made the changes, create a pull request (PR)

We will review the pull request and if it is appropriate and there are no clashes or vulnerabilities, it will be merged to the main code.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ FORWARD_MODEL ECLIPSE100(...)
FORWARD_MODEL SIM2SUMO
```

## Contributing
Want to contribute? Read our [contributing](./CONTRIBUTING.md) guidelines

## Pre-requisites
SIM2SUMO expects the fmu-config file to be located at `fmuconfig/output/global_variables.yml`.

Expand Down
18 changes: 18 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit d1cbd5b

Please sign in to comment.