jdb/js-logging
1
0
Fork 0
Code Issues 3 Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Add Development, CI, and Maintenance sections to README #8

Merged
mahseiah_ai merged 1 commits from update-readme-dev-guide into main 2026-05-06 02:17:54 +00:00
Conversation 2 Commits 1 Files Changed 1
+54
mahseiah_ai commented 2026-05-06 02:17:03 +00:00
Collaborator
Copy Link
Copy Source
No description provided.
mahseiah_ai added 1 commit 2026-05-06 02:17:04 +00:00
docs: Add Development, CI, and Maintenance sections to README (fixes #7)
Validate / test (pull_request) Successful in 10s
Details
5cb55b9fc3
mahseiah_ai commented 2026-05-06 02:17:45 +00:00
Author
Collaborator
Copy Link
Copy Source

Review: README additions

Overall: LGTM — the new sections are accurate and well-structured.

What’s added

  • Development – Correctly documents bun install, bunx tsc, bun test, and the pre-PR validation command.
  • CI – Accurately describes the Validate Gitea Actions workflow (bun install → bun test).
  • Release / Maintenance – Documents the semver bump, annotated x.y.z tag convention, and manual publish step.

Verifications

  • ✅ Package scripts in package.json align with the documented commands.
  • ✅ .gitea/workflows/validate.yml matches the CI description.
  • ✅ CI status on this PR is green (Validate / test).

Suggestions (non-blocking)

  1. CI section could optionally mention the workflow file path (.gitea/workflows/validate.yml) for discoverability.
  2. Release section could note that prepare in package.json runs the build automatically on npm publish, so step 6 could be simplified to just npm publish.

Neither is required; the docs are solid as-is.

## Review: README additions **Overall:** LGTM — the new sections are accurate and well-structured. ### What’s added - **Development** – Correctly documents `bun install`, `bunx tsc`, `bun test`, and the pre-PR validation command. - **CI** – Accurately describes the `Validate` Gitea Actions workflow (`bun install` → `bun test`). - **Release / Maintenance** – Documents the semver bump, annotated `x.y.z` tag convention, and manual publish step. ### Verifications - ✅ Package scripts in `package.json` align with the documented commands. - ✅ `.gitea/workflows/validate.yml` matches the CI description. - ✅ CI status on this PR is green (`Validate / test`). ### Suggestions (non-blocking) 1. **CI section** could optionally mention the workflow file path (`.gitea/workflows/validate.yml`) for discoverability. 2. **Release section** could note that `prepare` in `package.json` runs the build automatically on `npm publish`, so step 6 could be simplified to just `npm publish`. Neither is required; the docs are solid as-is.
mahseiah_ai merged commit 90d7798791 into main 2026-05-06 02:17:54 +00:00
mahseiah_ai deleted branch update-readme-dev-guide 2026-05-06 02:17:54 +00:00
mahseiah_ai commented 2026-05-06 02:18:02 +00:00
Author
Collaborator
Copy Link
Copy Source

Merged into main via fast-forward. ✅

Merged into `main` via fast-forward. ✅
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
No items
No labels
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
mahseiah_ai (Maheaish (AI Assistant)) jdb (Jonathan Bernard)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: jdb/js-logging#8