Skip to content

Suggested Readme improvements #385

Description

@G-Fynn24

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 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
  • 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

    documentationImprovements or additions to documentationenhancementNew feature or requestopinions wantedCollaborators and users are encouraged to contribute their opinionspriority:3

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions