From b2d80c46775c033093e57f244d5b4ccb4050257f Mon Sep 17 00:00:00 2001 From: Claire Carouge Date: Tue, 26 Sep 2023 15:45:53 +1000 Subject: [PATCH] #141- User responsibilities --- documentation/docs/user_guide/index.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/documentation/docs/user_guide/index.md b/documentation/docs/user_guide/index.md index d47b899d09..95ea26ebc7 100644 --- a/documentation/docs/user_guide/index.md +++ b/documentation/docs/user_guide/index.md @@ -3,4 +3,28 @@ In the user guide, you will find: - a quick guide to install and run the CABLE tutorial. -- a more complete guide with full explanations to install, run, customise a CABLE simulation and understand the output from CABLE. \ No newline at end of file +- a more complete guide with full explanations to install, run, customise a CABLE simulation and understand the output from CABLE. + +## Users' responsitilities + +We ask all users of CABLE to consider contributing to the CABLE software in the following ways. + +### Report issues with using the CABLE software + +All issues should be **reported via a GitHub Issue or via the [ACCESS-Hive Forum][hive-forum-cable]** if there is no GitHub repository appropriate to report the issue. Some examples of issues to report, but not an exhaustive list, are listed below: + +- unclear documentation +- typos in documentation +- out-of-date documentation +- awkward workflow +- crash with supported configurations +- possibility of bugs in the code base + +### Acknowledge the developers + +Although the license on CABLE does not require attribution of the work by the users, we would appreciate if you could acknowledge the developers' contribution to your work where appropriate. Here are some suggested ways for you to acknowledge developers: + +- for features that are new to the CABLE version you are using, consider proposing **co-authorship** to the feature developer(s) when writing a scientific paper using that feature. +- consider **citing** the CABLE released version in your papers' references using the appropriate DOI. + +[hive-forum-cable]: https://forum.access-hive.org.au/c/land/cable/18