From db4058539aec1bfacd942dbfa42e15fd89d07a75 Mon Sep 17 00:00:00 2001 From: Keith Solomon Date: Sat, 29 Nov 2025 10:10:11 -0600 Subject: [PATCH] =?UTF-8?q?=E2=9C=A8feature:=20Initial=20commit?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .vscode/settings.json | 8 ++++++++ AGENTS.md | 38 ++++++++++++++++++++++++++++++++++++++ README.md | 3 +++ 3 files changed, 49 insertions(+) create mode 100644 .vscode/settings.json create mode 100644 AGENTS.md create mode 100644 README.md diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..0ea9617 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,8 @@ +{ + "workbench.colorCustomizations": { + "tree.indentGuidesStroke": "#3d92ec", + "activityBar.background": "#040d26", + "titleBar.activeBackground": "#040d26", + "titleBar.activeForeground": "#FCFBFE" + } +} diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..6c71a7c --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,38 @@ +# Repository Guidelines + +## Project Structure & Module Organization + +- Root Markdown notes live alongside `README.md`; add new docs near related topics to keep discovery simple. +- Use clear filenames with kebab-case (`api-integration-notes.md`) and group related references with optional directories if a topic grows. +- `.vscode/` holds workspace preferences; avoid committing personal or machine-specific settings. + +## Build, Test, and Development Commands + +- No build pipeline is required; files are plain Markdown. +- If you have `markdownlint` installed locally, run `npx markdownlint "**/*.md"` to catch common formatting issues. +- Use a Markdown preview in your editor to verify headings, lists, and code blocks render as expected. + +## Coding Style & Naming Conventions + +- Write in concise, direct prose; prefer short sections with descriptive headings. +- Use fenced code blocks with language hints (` ```js`, ` ```bash`) and avoid trailing whitespace; wrap lines around 100 characters for readability. +- Favor ordered lists for sequences and unordered lists for checklists; keep tables minimal. +- Filenames: lowercase kebab-case; avoid spaces and punctuation beyond dashes. + +## Testing Guidelines + +- Proofread for accuracy and broken references before publishing. +- Run `npx markdownlint "**/*.md"` when available; resolve lint warnings instead of suppressing them. +- For code snippets, include the minimal runnable example; note prerequisites if a command depends on a tool or version. + +## Commit & Pull Request Guidelines + +- Commit messages: imperative mood, short summary (`docs: add api auth notes`), followed by optional detail in the body. +- Keep commits scoped to a single topic (one note or one refactor) to simplify review. +- Pull requests should describe the intent, list key changes, and call out any TODOs or open questions. +- Link related issues or tasks when applicable and add screenshots only if rendering changes are involved. + +## Security & Configuration Tips + +- Do not store secrets, tokens, or private endpoints in notes; use placeholders (``) and reference secure vault locations instead. +- If sharing configuration snippets, redact hostnames and credentials and prefer environment-variable examples. diff --git a/README.md b/README.md new file mode 100644 index 0000000..ecba6f5 --- /dev/null +++ b/README.md @@ -0,0 +1,3 @@ +# Dev Notes + +My Collection of notes, ponderings, and documentation for various dev projects.