{"id":335,"date":"2015-11-03T14:41:13","date_gmt":"2015-11-03T14:41:13","guid":{"rendered":"http:\/\/95.85.43.55\/?page_id=335"},"modified":"2024-02-06T08:52:43","modified_gmt":"2024-02-06T08:52:43","slug":"how-to-contribute","status":"publish","type":"page","link":"https:\/\/opm-project.org\/?page_id=335","title":{"rendered":"How to contribute"},"content":{"rendered":"

We welcome contributions of all kinds to make Opm better and more useful! This can take any form: use case reports, documentation, bug reports, source code improvement or entirely new software modules.<\/p>\n

Use case reports, figures and documentation<\/h4>\n

We are interested in your experience\u00a0using OPM software to solve your problems! Please contact us if you have a successful use case, and we can add it to the gallery.<\/p>\n

Bug reports, issues and feature requests<\/h4>\n

For this, we use the issue tracker of github. There is one such tracker per individual module, so where to report depends on the application:<\/p>\n\n\n\n\n\n\n
Application<\/th>\nModule<\/th>\nLink<\/th>\n<\/tr>\n
Flow<\/td>\nopm-simulators<\/td>\nIssue tracker<\/a><\/td>\n<\/tr>\n
Cpchop (and other upscaling tools)<\/td>\nopm-upscaling<\/td>\nIssue tracker<\/a><\/td>\n<\/tr>\n
ResInsight<\/td>\nResInsight<\/td>\nIssue tracker<\/a><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

On the issue tracker page, click the “New Issue” button to report a problem.<\/p>\n

For more general requests and questions, consider asking on the\u00a0mailing list<\/a>. Also you can use the list for bug reporting if you cannot identify which module contains the bug, or which one is most appropriate.<\/p>\n

Contributing to the software suite<\/h4>\n

The preferred method of contributing bug fixes, documentation improvements or new features to the existing software is to use the\u00a0pull request mechanism<\/a>\u00a0of github. We mostly follow the Fork & Pull<\/em> model, meaning that you should fork the repository to your own github user and put your contributions there before asking us to pull you changes into the\u00a0common repositories<\/a>.<\/p>\n

If your contribution is in a new field or is otherwise separate from the existing software, consider suggesting a new module. The best place to do so is on the\u00a0mailing list<\/a>.<\/p>\n

Contributors<\/h4>\n

These are the\u00a0organizations that have contributed to OPM, with software development,\u00a0financial support or both.<\/p>\n

Financial contributors<\/em><\/p>\n