Compare commits

...

2 Commits

Author SHA1 Message Date
copilot-swe-agent[bot]
0d52b35568
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>
2026-04-16 20:09:47 +00:00
copilot-swe-agent[bot]
5c793f44e9
Add baseline repository files and complete README
Agent-Logs-Url: https://github.com/donnyandjoern-debug/personal/sessions/977d8693-f02a-4b80-8c96-4d68dff8e35f

Co-authored-by: donnyandjoern-debug <262665187+donnyandjoern-debug@users.noreply.github.com>
2026-04-16 20:06:36 +00:00
7 changed files with 141 additions and 2 deletions

12
.gitignore vendored Normal file
View File

@ -0,0 +1,12 @@
# Operating system
.DS_Store
Thumbs.db
# Editors and IDEs
.idea/
.vscode/
*.swp
*.swo
# Logs
*.log

36
CONTRIBUTING.md Normal file
View File

@ -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

21
LICENSE Normal file
View File

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2026 Family Hoppe
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

View File

@ -1,2 +1,39 @@
# personal # Personal Repository (Family Hoppe)
personal repository for Family Hoppe
This repository is the shared personal space for Family Hoppe projects, notes, and small experiments.
## Purpose
- Keep family-related project files in one place
- 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 with baseline project structure
- Basic documentation in place
- Standard ignore rules and license added
## Getting Started
1. Clone the repository
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
See `CONTRIBUTING.md` for branching, commit, and pull-request conventions.

11
docs/README.md Normal file
View File

@ -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

13
src/README.md Normal file
View File

@ -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, …)
```

9
tests/README.md Normal file
View File

@ -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.