Skip to content

Latest commit

 

History

History
110 lines (67 loc) · 2.67 KB

CONTRIBUTING.rst

File metadata and controls

110 lines (67 loc) · 2.67 KB
Raw

Contributing

Contributions are welcome, and they are greatly appreciated. Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of contributions

Report bugs

Report bugs at https://github.com/equinor/fmu-ensemble/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix bugs

Look through the Git issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.

Implement features

Look through the Git issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.

Write documentation

fmu-ensemble could always use more documentation, whether as part of the official fmu-ensemble docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/equinor/fmu-ensemble/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.

Code standards

It is very important to be complient to code standards. A summary:

PEP8 and PEP20

  • Use PEP8 standard (https://www.python.org/dev/peps/pep-0008/) and PEP20 philosophy, with line length set 88.
  • Use the source code formatter ruff (https://github.com/astral-sh/ruff)
  • Naming: files_as_this, ClassesAsThis, ExceptionsAsThis, CONSTANTS, function_as_this, method_as_this
  • Use a single underscore to protect instance variables, other private variables and and private classes
  • 4 space indents (spaces, no tabs)
  • One space before and after =, +, * etc
  • No space around = in keyword lists, e.g. my_function(value=27, default=None)
  • Avoid one or two letter variables, even for counters. And meaningful names, but don't overdo it.

In addition:

  • Start with documentation and tests. Think and communicate first!
  • Docstrings shall start and end with """.
  • Use pytest as testing engine
  • Code shall be be Python 3.8+ compliant

Use flake8 and/or pylint to check

python -m flake8 mycode.py

make flake   # for all

The pylint is rather strict and sometimes exceptions are needed... , but anyway quite useful!

python -m pylint mycode.py

make lint   # for all