DOC: Add contributing document #415
Conversation
janbjorge
changed the title
There was a problem hiding this comment.
@perolavsvendsen and @jcrivenaes will have the final word but I'm not sure we want to start adding the commit prefixing here too
docs/contributing.rst
Outdated
| .. code-block:: text | ||
|
|
||
| API: an (incompatible) API change (will be rare) | ||
| BLD: change related to building fmu-dataio | ||
| BUG: bug fix | ||
| CLN: code cleanup, maintenance commit (refactoring, typos, PEP, etc.) | ||
| DEP: deprecate something, or remove a deprecated object |
There was a problem hiding this comment.
Maybe @perolavsvendsen and @jcrivenaes have might feel differently, but I don't think we should bring numpy-style commit prefixing into this repo
There was a problem hiding this comment.
We have not made this convention for this repo (we have not actually discussed it either, yet).
There was a problem hiding this comment.
According to Equinor requirements, there shall be a CONTRIBUTING.md (MarkDown format) in top level. This is recently done in xtgeo, and then the MarkDown is linked into the rst documentation tree via myst_parser. See https://github.com/equinor/xtgeo/blob/main/docs/contributing.rst
I propope you should do it in the same manner here.
Copy of https://github.com/equinor/xtgeo/blob/main/docs/contributing.rst with some modifications (dropped the section about how to run stuff in RMS)