mroth/sseserver

consider renaming the project

Open

#3 opened on Jul 16, 2018

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Go (17 forks)github user discovery
help wanted

Repository metrics

Stars
 (115 stars)
PR merge metrics
 (PR metrics pending)

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

Research direction
Brainstorm a new project name that is descriptive of the library's features (namespacing, performance) and does not cause stuttering. Then update all references in code, documentation, and configuration files accordingly.
Tech stack
go
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GoGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80