Skip to content

Suggested Readme improvements #22

Description

@tasminmin

As part of a Documentation quality analysis project led by ARC, we've found this repository could be improved in the following areas by:

  • Adding information on how to install this project
  • Fixing the information about the insatallation as currently it fails when...
  • Adding a short example on how to use this project
  • Providing information on how the users could ask for help
  • Consider including whether using GenAI is acceptable for contributions
  • Adding information about how you would like this project to be cited. Using a citation-file-format would also help reference managment tools to discover the preferred citation/acknowledgement way.
  • Providing a DOI in the citation snippet will help to the researchers to find the object you'd like to be cited
  • Consider adding a changelog to inform your users what's changed between versions
  • Adopting a Code of Conduct

If you need help with anything of the the above, join one of ARC Drop-in sessions and one of our team members will help you.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions