search

souradipp76 / ReadMeReady

Tool for auto-generating README documentation for code repositories
https://souradipp76.github.io/ReadMeReady/
Apache License 2.0
1 stars 0 forks source link

[JOSS-Review][Third-Party guidelines] Add guidelines on how to seek support #9

Closed Manvi-Agrawal closed 2 days ago

Manvi-Agrawal commented 1 week ago

JOSS Reviewer checklist item

JOSS Review Issue: https://github.com/openjournals/joss-reviews/issues/7489 Are there clear guidelines for third parties wishing to:

  1. Contribute to the software: CONTRIBUTING.md
  2. Report issues or problems with the software : README.md
  3. Seek support: Currently, README/CONTRIBUTING doesnt state how should someone ask for help? Are there any dedicated slack channels/discord server? Mailing list? Should someone open github issue?

Minor Nitpick[Non Blocking]

I would appreciate if the details about software issues could be moved to CONTRIBUTING.md. I have a habit to skim through the things. Consider Q# style, brief in README, expands in CONTRIBUTING: https://github.com/microsoft/qsharp?tab=readme-ov-file#contributing. This is just a minor suggestion, not too binding, since this repository contains good issue, bug and PR templates.

souradipp76 commented 6 days ago

@Manvi-Agrawal, I have added a section in CONTRIBUTING.md instructing users to simply raise a GitHub issue in case of questions.