adjustments to docs

Author: avivajpeyi

CONTRIBUTING.md

@@ -0,0 +1,22 @@
+# Release Process
+
+We use `python-semantic-release`.
+This package will automatically determine the next version number based on the commit messages.
+Example commit messages:
+
+**Patch Release (e.g., 0.1.1):**
+```
+fix: resolve issue with missing argument
+```
+
+**Minor Release (e.g., 0.2.0):**
+```
+feat: add new feature to API
+```
+
+**Major Release (e.g., 1.0.0):**
+```
+feat!: introduce breaking change to architecture
+```
+The ! after feat indicates a breaking change.
+If your commit messages don't match these patterns, python-semantic-release will decide that no release is needed (no_release).

README.md

@@ -1,3 +1,7 @@
+[![Coverage Status](https://coveralls.io/repos/github/COMPAS-Surrogate/lnl_surrogate/badge.svg?branch=main)](https://coveralls.io/github/COMPAS-Surrogate/lnl_surrogate?branch=main)
+[![PyPI version](https://badge.fury.io/py/compas_python_utils.svg?icon=si%3Apython)](https://badge.fury.io/py/compas_python_utils)
+
+
 # Compas Python Utils
 
 The python utilities for [COMPAS code](github.com/TeamCOMPAS/COMPAS).