FAForever/server

[After TMM] Revise protocol documentation

Open

#482 opened on Jul 28, 2019

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Python (79 forks)auto 404
good first issue

Repository metrics

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

Description

We really need a dedicated server protocol document where we write down what messages are sent by the client, and what responses come from the server. That way the client developers can have something to reference without needing to read the server code. This would also push us toward defined protocol versions where we can explicitly say "version 1.0 has exactly these commands".

Ideally we would refactor the server so that much of this documentation could be generated automatically from doc strings.

Contributor guide

Research direction
Read the server source code to identify all client server messages and their responses, then compile them into a structured protocol document.
Tech stack
python
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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
GitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80