Skip to content

docs: include how-to information for getting help/reporting bugs #2395

@SnoopJ

Description

@SnoopJ

Requested Feature

It's common for errors reported in a reply by a Sopel instance to be inadequate for debugging what went wrong, so that the first step in getting a user the assistance they need is helping them locate and share the logs for their instance. It would be handy to have more of a formal "how to get help" narrative to make the experience more consistent for both users and helpers, and there may be other common advice/procedures that could be laid out in a document like that.

Problems Solved

No response

Alternatives

No response

Notes

There's some notes in CONTRIBUTING.md and some information about logger configuration in the docs that are good starting points for this request.

Some 'prior art' in other projects:

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions