From 5642614416c564785e89d79696da66b1cc243713 Mon Sep 17 00:00:00 2001 From: Binrui XU <145786190+xubinrui@users.noreply.github.com> Date: Sat, 18 Apr 2026 18:55:10 +0000 Subject: [PATCH] docs: add minimal repository scaffold docs --- .gitignore | 16 ++++++++++++++++ README.md | 16 +++++++++++++++- 2 files changed, 31 insertions(+), 1 deletion(-) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9c37b04 --- /dev/null +++ b/.gitignore @@ -0,0 +1,16 @@ +node_modules/ +dist/ +build/ +coverage/ + +.env +.env.* +!.env.example + +.DS_Store +Thumbs.db + +.idea/ +.vscode/ +*.swp +*.swo diff --git a/README.md b/README.md index d3809b0..2a3e647 100644 --- a/README.md +++ b/README.md @@ -1 +1,15 @@ -# test-code \ No newline at end of file +# test-code + +This repository is currently a minimal scaffold for a small JavaScript or static-web project. It does not include application code, dependencies, or build tooling yet. + +## Current Files + +- `README.md`: project status and contributor notes +- `.gitignore`: common local, build, editor, and OS exclusions + +## Contributor Guidance + +- Keep new additions small and easy to review. +- Add documentation alongside any new source files or tooling. +- Avoid committing generated output, secrets, local environment files, or editor-specific files. +- Introduce build configuration or dependencies only when the repository has a clear implementation need.