markcornwell / markcornwell/spacewar
Document the interface for the lobby (matchmaker) service.
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 0
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
The lobby service has a REST interface. This is a natural for some sort of standard documentation. Look for some sort of database or template for such documentation.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the lobby (matchmaker) service and its REST interface in the repository. Identify the available endpoints and determine an appropriate standard or template for documenting them; the work is done when the service interface is documented consistently and the chosen documentation source is clear.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100