docs: add a README to each service folder
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 85/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- shell
- Domain
- documentation
Research direction
Read the four service folders: services/appointment/appointment-api, appointment-app, identity/identity-api, and identity-app. Check each service.json for its port, then inspect src/ and the project’s existing check instructions to document each service’s role and checks. Done when every folder has a short README and its documented port matches service.json.
Written by the indexing model from the issue text.
Description
The four service folders (services/appointment/appointment-api, appointment-app, identity/identity-api, identity-app) have no README, so a reader has to open service.json and src/ to learn what each one does.
To do
- Add a short README per folder: its role, its port (from
service.json), and how to run its checks.
Done when: each folder has a README whose port matches its service.json.
- Dominant language
- Shell
- Stars
- 3
- Forks
- 0
- Avg merge
- 5m
- Merged PRs (30d)
- 6
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
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.
More from flisk-sh/flisk-example
-
agents area: runtime automation chore cli consistency dependencies developer-experience difficulty: easy documentation enhancement good first issue help wanted hygiene json-output priority: P3 starters tests
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
flisk-sh/flisk-example#41 ·
Maintainers usually reply within 1 day
-
area: ci area: infrastructure benchmark ci-cd configuration developer-experience difficulty: easy dx enhancement good first issue hacktoberfest help wanted latency performance quality rank: 8 kyu tech: github-actions tech: postgres yaml
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
flisk-sh/flisk-example#39 ·
Maintainers usually reply within 1 day
-
area: ci difficulty: easy good first issue hacktoberfest help wanted
Difficulty 1/5 1-3 hours Newbie friendliness 84/100
flisk-sh/flisk-example#14 ·
Maintainers usually reply within 1 day
-
area: docs difficulty: easy good first issue hacktoberfest help wanted
Difficulty 1/5 Under an hour Newbie friendliness 92/100
flisk-sh/flisk-example#13 ·
Maintainers usually reply within 1 day
-
area: tests difficulty: medium hacktoberfest help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
flisk-sh/flisk-example#12 ·
Maintainers usually reply within 1 day
All issues in flisk-sh/flisk-example
Similar issues
-
agents area: runtime automation chore cli consistency dependencies developer-experience difficulty: easy documentation enhancement good first issue help wanted hygiene json-output priority: P3 starters tests
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
area:claude-code-web bug has repro platform:linux platform:web
Difficulty 1/5 Under an hour Newbie friendliness 66/100
anthropics/claude-code#110168 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
devcontainers/features#1776 · 1 comment ·
Maintainers usually reply within 3 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 80/100
btclib-org/portanode#968 · 1 comment ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day