From 0d52b35568189232bdc87691071b8d6b68e1e77b Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Thu, 16 Apr 2026 20:09:47 +0000 Subject: [PATCH] Add docs/, src/, tests/ directories and CONTRIBUTING.md Agent-Logs-Url: https://github.com/donnyandjoern-debug/personal/sessions/5bec8cf7-24ec-4fdc-9f1c-6bb76465898b Co-authored-by: donnyandjoern-debug <262665187+donnyandjoern-debug@users.noreply.github.com> --- CONTRIBUTING.md | 36 ++++++++++++++++++++++++++++++++++++ README.md | 22 ++++++++++++++++++---- docs/README.md | 11 +++++++++++ src/README.md | 13 +++++++++++++ tests/README.md | 9 +++++++++ 5 files changed, 87 insertions(+), 4 deletions(-) create mode 100644 CONTRIBUTING.md create mode 100644 docs/README.md create mode 100644 src/README.md create mode 100644 tests/README.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..a7b28a5 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,36 @@ +# Contributing + +Thank you for contributing to the Family Hoppe personal repository! Please follow these guidelines to keep things tidy. + +## Branching + +- Work on a dedicated branch, never directly on `main`. +- Use descriptive branch names, e.g. `feature/add-recipe-tracker` or `fix/typo-in-docs`. + +## Commits + +- Write short, meaningful commit messages in the imperative mood. + ✅ `Add holiday photo script` + ❌ `added stuff` +- Keep commits focused – one logical change per commit. + +## Pull Requests + +1. Fork / branch off `main`. +2. Make your changes and add or update tests where relevant. +3. Ensure all tests pass before opening the PR. +4. Fill in the PR description with a brief summary of what changed and why. +5. Request a review from at least one other family member. + +## Code Style + +- Prefer clear, readable code over clever one-liners. +- Add comments when the *why* is not obvious from the code itself. +- Follow the conventions of whichever language you are using. + +## Reporting Issues + +Open a GitHub Issue with: +- A clear title +- Steps to reproduce (if applicable) +- Expected vs. actual behaviour diff --git a/README.md b/README.md index 468232a..8e1dd33 100644 --- a/README.md +++ b/README.md @@ -8,18 +8,32 @@ This repository is the shared personal space for Family Hoppe projects, notes, a - Track changes over time with Git - Provide a clean base for future additions +## Repository Structure + +``` +personal/ +├── docs/ # Guides, notes, and decision records +├── src/ # Source code and scripts +├── tests/ # Tests for code in src/ +├── CONTRIBUTING.md +├── LICENSE +└── README.md +``` + ## Current Status -- Repository initialized +- Repository initialized with baseline project structure - Basic documentation in place - Standard ignore rules and license added ## Getting Started 1. Clone the repository -2. Create or update files as needed -3. Commit your changes with clear messages +2. Browse `docs/` for guidance or add documentation there +3. Place source code under `src/` and matching tests under `tests/` +4. Commit your changes with clear messages +5. See [CONTRIBUTING.md](CONTRIBUTING.md) before opening a pull request ## Notes -This repository currently contains baseline files only and is ready for content to be added. +See `CONTRIBUTING.md` for branching, commit, and pull-request conventions. diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..82d8b4b --- /dev/null +++ b/docs/README.md @@ -0,0 +1,11 @@ +# Documentation + +This directory contains documentation for Family Hoppe projects. + +## Structure + +Add topic-specific markdown files here as projects grow, for example: + +- `how-to-*.md` – guides and how-tos +- `decisions/` – architecture / decision records +- `notes/` – free-form notes and ideas diff --git a/src/README.md b/src/README.md new file mode 100644 index 0000000..62f531b --- /dev/null +++ b/src/README.md @@ -0,0 +1,13 @@ +# Source + +This directory is the home for source code and scripts belonging to Family Hoppe projects. + +## Structure + +Organise code by project or language, for example: + +``` +src/ + project-name/ + main.py (or index.js, main.go, …) +``` diff --git a/tests/README.md b/tests/README.md new file mode 100644 index 0000000..f72e43a --- /dev/null +++ b/tests/README.md @@ -0,0 +1,9 @@ +# Tests + +This directory contains tests for the code living in `src/`. + +## Conventions + +- Mirror the `src/` folder structure so each source file has a corresponding test file. +- Name test files with a `test_` prefix (Python) or `.test.js` / `_test.go` suffix depending on the language used. +- Run all tests before opening a pull request.