Skip to content

Commit

Permalink
docs: Add "Contributing" section to README
Browse files Browse the repository at this point in the history
  • Loading branch information
djmaxus committed Jan 11, 2024
1 parent 924b4dc commit 30dd8fa
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
* [What is StrataTrapper upscaling toolkit?](#what-is-stratatrapper-upscaling-toolkit)
* [Code structure](#code-structure)
* [How to run codes](#how-to-run-codes)
* [Contributing](#contributing)
* [References](#references)

## What is StrataTrapper upscaling toolkit?
Expand Down Expand Up @@ -38,6 +39,10 @@ Other folder and files are repository-related.
5. Use `Result/ECLIPSE_RUN.DATA` as an input for reservoir simulation software.
The generated file corresponds to the version 2019 of ECLIPSE.

## Contributing

Everyone is welcome to open [issues](https://github.com/ImperialCollegeLondon/StrataTrapper/issues) and [pull requests](https://github.com/ImperialCollegeLondon/StrataTrapper/pulls).

## References

Please refer to the User Manual in the `Reference` folder
Expand Down

0 comments on commit 30dd8fa

Please sign in to comment.