mroth / mroth/sseserver

consider renaming the project

Open
#3 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

help wanted
Dominant language
Go
Stars
115
Forks
17
PR merge metrics
No merged PRs in 30d

Description

Reasons:

  • sseserver is very generic, and doesn't imply any of the nice functionality (namespacing support and fast performance) in this library.
  • sseserver can be confusing to spell, due to the overlapping collision (s[se)rver].
  • sseserver.Server stutters, a no-no in Go best practices.

I am actively interested in improving this code again (and making some decent strides in the develop branch which will eventually be cleaned up and squashed towards a v1.1), and with the proliferation of HTTP/2, SSE may see a resurgence of interest (hence my work on cleanups and the API currently). So if I'm going to rename the project, it should probably be done sooner rather than later, since that's easier when not many people are using it.

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

Review the naming concerns in the issue alongside the develop branch and current project/API naming. A contribution would need a decided replacement name and agreed scope for renaming the project and Server API; no file or test is identified, so maintainers must define what done means.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
api, backend
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
18/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.