跳到正文
DEV Community· miodrag “Toto Madjaro” milijic·· 30 分鐘前AI 評分48

單人開發者的兩個工作階段 PROJECT_STATUS.md 範例

A Two-Session PROJECT_STATUS.md Example for Solo Developers

AI 導讀

文章以虛構筆記應用程式 Lantern Notes 示範,單人開發者如何用 PROJECT_STATUS.md 在兩個工作階段之間交接進度,記錄目前焦點、可立即開始的下一步、待決定事項及已完成的檢查。回歸工作後,開發者核對狀態檔與近期提交及工作目錄,再測試搜尋「archive」沒有結果的情況,並列明仍待執行的應用程式檢查。

正文

When I pick up a coding project after a break, I want to know three things. Where did I stop? Which decision is still open? What can I do next?

A short PROJECT_STATUS.md at the root of the repository gives me one place to leave those answers. Here’s a two-session walkthrough using Lantern Notes, a fictional app that searches saved notes by title and tag. The project history and application test results in the example are fictional.

Session 1 — leave a next action you can start

The developer adds title search and reports a manual check with a matching title. Tag filtering is underway, and one decision is still open. Should Work and work count as the same tag?

Before stopping, the developer leaves this excerpt in PROJECT_STATUS.md.

# Current focus

Make saved notes easy to find by title and tag.

# Next actions

- [ ] Validate empty search results.

# Blocked

- Decide whether Work and work should be treated as the same tag.

# Recently completed

- [x] Added title search and checked a matching title locally.

The matching-title check covers a successful search. The empty-result case is a concrete next action the developer can start while waiting on the tag decision.

Session 2 — check the evidence and pick up one task

On return, the developer reads the status file and checks its update date against recent commits and the working tree. Then they pick the empty search case. It can be reviewed with the tag filter off, while the decision about tag case sensitivity is still pending.

The fixture contains two titles, Release notes and Weekend plans. Paste this into a JavaScript console to work out the expected result for archive.

const titles = ['Release notes', 'Weekend plans'];
const query = 'archive';
const matches = titles.filter((title) => title.toLowerCase().includes(query));
console.log(matches); // []

The exercise returns zero matches for these two titles. The next check is to enter the same query in a running build and confirm that the search view displays its empty state and leaves the saved notes intact. The developer records the fixture result and keeps the application check open.

# Recently completed

- [x] Reviewed the empty-result fixture. The query archive matched zero of two titles.

# Testing required

- [ ] In a running build, search for archive with no tag filter and verify the empty state.

When you leave your own project, record the current focus, one next action you can start, any open decision, and what you actually checked. When you return, compare the note with the repository and carry forward the checks that still need to run.

Try it with the complete example

The full demo includes the end-of-session status file, the handoff into Session 2, and the search checklist. You can follow it in a text editor. Lantern Notes GitHub demo

The excerpts above omit the front matter and other sections. For a complete example in StateConsole’s supported format, start with the validated PROJECT_STATUS.md template.

I work on StateConsole, which publishes the linked template and demo. AI generated the initial draft of this article.

來源:DEV Community · dev.to