Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reporting Issues and Seeking Support #47

Closed
mmore500 opened this issue May 9, 2024 · 2 comments
Closed

Reporting Issues and Seeking Support #47

mmore500 opened this issue May 9, 2024 · 2 comments

Comments

@mmore500
Copy link
Contributor

mmore500 commented May 9, 2024

The README provides an email address to contact a library author, which is helpful. However, more explicit instructions to new/unfamiliar users should be considered. A link to the GitHub issues page would probably be appropriate for issue reporting. Consider adding an issue template to further assist users in opening informative issues. Instructions to seek support should also be explicitly described --- should this go to the issue tracker, to the author email, somewhere else?

@mmore500
Copy link
Contributor Author

mmore500 commented May 9, 2024

part of review for JOSS openjournals/joss-reviews#6579

@hazem-dev
Copy link
Collaborator

Thank you for your valuable suggestion regarding the issue template. We have now added an issue template to assist users in opening informative issues and to streamline the issue reporting process. Your input has greatly improved our documentation, and we appreciate your contribution.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants