Encourage contributions

Update README.md and CONTRIBUTING.md accordingly.
CLIMADA-project · Oct 27, 2023 · f80613f · f80613f
1 parent 12c3190
commit f80613f
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 3 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,8 +1,23 @@
 # CLIMADA Contribution Guide
 
-Thank you for contributing to CLIMADA!
+We welcome any contribution to CLIMADA and want to express our thanks to everybody who contributes.
 
-## Overview
+## What Warrants a Contribution?
+
+Anything!
+For orientation, these are some categories of possible contributions we can think of:
+
+* **Technical problems and bugs:** Did you encounter a problem when using CLIMADA? Raise an [issue](https://github.com/CLIMADA-project/climada_python/issues) in our repository, providing a description or ideally a code replicating the error. Did you already find a solution to the problem? Please raise a pull request to help us resolve the issue!
+* **Documentation and Tutorial Updates:** Found a typo in the documentation? Is a tutorial lacking some information you find important? Simply fix a line, or add a paragraph. We are happy to incorporate you additions! Please raise a pull request!
+* **New Modules and Utility Functions:** Did you create a function or an entire module you find useful for your work? Maybe you are not the only one! As a module has to be carefully integrated into the framework, it might help if you talk to us first for designing and planning. You can do that by raising an issue or starting a [discussion](https://github.com/CLIMADA-project/climada_python/discussions) on GitHub.
+
+## Why Should You Contribute?
+
+* You will be listed as author of the CLIMADA repository in the [AUTHORS](AUTHORS.md) file.
+* You will improve the quality of the CLIMADA software for you and for everybody else using it.
+* You will hopefully gain insights into scientific software development.
+
+## Minimal Steps to Contribute
 
 Before you start, please have a look at our [Developer Guide][devguide].
 

diff --git a/README.md b/README.md
@@ -61,7 +61,9 @@ Please use the following logo if you are presenting results obtained with or thr
 
 ## Contributing
 
-See the [Contribution Guide](CONTRIBUTING.md).
+We welcome any contribution to this repository, be it bugfixes and other code changes and additions, documentation improvements, or tutorial updates.
+
+If you would like to contribute, please refer to our [Contribution Guide](CONTRIBUTING.md).
 
 ## Versioning