mattermost / mattermost/mattermost-developer-documentation

Help Wanted: Use `github.com/pkg/errors` for all server error handling

Open
#612 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Help Wanted Needs Documentation Up For Grabs
Dominant language
CSS
Stars
90
Forks
460
Avg merge
9d 23h
Merged PRs (30d)
2

Description

Mattermost user ali.farooq from https://community-daily.mattermost.com has requested the following be documented:

Maybe this decision is worth documenting in https://developers.mattermost.com/contribute/server/, as a lot of people are confused by what they should use.

See the original post here.

Since this is a stylistic request, might be worth documenting under https://docs.mattermost.com/developer/style-guide.html

This issue was generated from Mattermost using the Doc Up plugin.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked server contribution page and developer style guide to determine where this guidance belongs. Document the agreed approach to server error handling and link the relevant page from the other location if appropriate. The work is done when contributors can find clear guidance on which error package to use.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.