Skip to content

Commit

Permalink
Add CONTRIBUTING.md and SECURITY.md (#29)
Browse files Browse the repository at this point in the history
  • Loading branch information
equinor-ruaj authored Jan 19, 2024
1 parent e27d194 commit 22e179d
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 1 deletion.
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.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,4 +73,7 @@ pip install git+https://github.com/equinor/fmu-sumo-sim2sumo.git
The [Explorer](https://github.com/equinor/fmu-sumo) is also installed under `fmu/sumo`. Meaning that if the testing scenario includes the Explorer then it should also be installed on top of Komodo.
```
pip install git+https://github.com/equinor/fmu-sumo.git
```
```

# Contributing
Want to contribute? Read our [contributing](./CONTRIBUTING.md) guidelines
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 22e179d

Please sign in to comment.