masukomi / masukomi/private_comments

status page should provide app info & be verified by client

Open
#4 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement good first issue
Dominant language
Scheme
Stars
48
Forks
2
PR merge metrics
No merged PRs in 30d

Description

This is a 2 parter:

  1. the private_comments server's status page (/status) should have additional fields which indicate the name and version of the app.
  2. the pc client should verify that the JSON coming back is actually from a private comments and that it's from a version that the client is compatible with.

Contributor guide

No contributing guide indexed for this repository

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 at the server's /status endpoint and the pc client's handling of its JSON response. Define the app name and version fields, then verify that the client accepts only responses from private_comments versions it supports.

Written by the indexing model from the issue text.

Assessment

Domain
api, backend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.