From f4963db45dc83becabb17c27961e2639170009e7 Mon Sep 17 00:00:00 2001 From: Binrui XU <145786190+xubinrui@users.noreply.github.com> Date: Sat, 18 Apr 2026 18:56:17 +0000 Subject: [PATCH] docs: add repository scaffold docs --- .gitignore | 21 +++++++++++++++++++++ README.md | 15 ++++++++++++++- 2 files changed, 35 insertions(+), 1 deletion(-) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..6055700 --- /dev/null +++ b/.gitignore @@ -0,0 +1,21 @@ +node_modules/ +dist/ +build/ +coverage/ +out/ + +.env +.env.* + +.DS_Store +Thumbs.db + +.idea/ +.vscode/ +*.swp +*.swo + +npm-debug.log* +yarn-debug.log* +yarn-error.log* +pnpm-debug.log* diff --git a/README.md b/README.md index d3809b0..71f8fc6 100644 --- a/README.md +++ b/README.md @@ -1 +1,14 @@ -# test-code \ No newline at end of file +# test-code + +This repository is intentionally minimal at the moment. It currently provides only a lightweight project scaffold so future work can add application code and tooling in a clean, deliberate way. + +## Current files + +- `README.md`: project overview and contributor notes. +- `.gitignore`: common ignores for a small JavaScript or static-web repository. + +## Contributor guidance + +- Keep early changes small and well-scoped. +- Add application code, dependencies, and build tooling only when there is a clear need. +- Document any new top-level files or directories in this README as the repository grows.