search

D-K-E / graphical-models

Probabilistic Graphical Models from Scratch with support for LWF Chain Graphs
GNU General Public License v3.0
4 stars 2 forks source link

Ask users with issues/need support to file a GitHub issue? #2

Closed eigenfoo closed 3 years ago

eigenfoo commented 3 years ago

[cc openjournals/joss-reviews/issues/3115]

From the review checklist:

Community guidelines: Are there clear guidelines for third parties wishing to 1) Contribute to the software 2) Report issues or problems with the software 3) Seek support

Right now the README outlines how users might contribute to the software, but doesn't explicitly ask users who have issues or need support to file an issue on GitHub. It's probably a safe bet from a user's perspective, but best to make this explicit on the README and/or documentation!

D-K-E commented 3 years ago

@eigenfoo I added two templates for helping users to add documentation, and explicitly mention filing an issue at the end. How does that look ?

eigenfoo commented 3 years ago

Great, thanks for adding!