Commenting Guidelines βš–#

Note that the comments’ section is activated throughout the Documentation. The main reason to do so is to allow sharing and discussing ideas where the community can be engaged in the details of this library. However, this adds some responsibility to keep the comments’ section as professional as possible.

Note

You need a GitHub account to be able to comment and collaborate in ReservoirFlow.

Therefore, we suggest the following points as a guideline:
  • always make sure that your comment is to the point.

  • avoid unnecessary comments (e.g., hello, thanks, first comment etc.).

  • instead of short comments use reactions.

  • do not repeat your comments.

  • harmful/unrelated comments or links are not allowed.

Warning

Our team has no responsibility over what users write.

Important

Comments can be deleted or locked if they are outdated, unnecessary or do not meet the conditions.