codeforpdx / codeforpdx/tenantfirstaid

Semantic versioning

Open
#175 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue
Dominant language
Python
Stars
13
Forks
21
Avg merge
6d 7h
Merged PRs (30d)
3

Description

We need a single version (single-source-of-truth) that represents the deployment of the app (both frontend and backend). The backend has a version (that hasn't been incremented in a long time) in pyproject.toml (which could be dynamic).

There should be an endpoint so that the version is gettable and visible in the webpage. This removes ambiguity about what version of the website a user is interacting 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 by inspecting pyproject.toml to understand the existing backend version and how it is currently defined. Trace how the backend can expose that value through an endpoint and where the webpage can display it. Done means frontend and backend deployments report one consistent semantic version with no ambiguity about the running website version.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, backend-api-design, full-stack
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.