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>
This commit is contained in:
parent
5c793f44e9
commit
0d52b35568
36
CONTRIBUTING.md
Normal file
36
CONTRIBUTING.md
Normal 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
|
||||
22
README.md
22
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.
|
||||
|
|
|
|||
11
docs/README.md
Normal file
11
docs/README.md
Normal 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
13
src/README.md
Normal 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
9
tests/README.md
Normal 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.
|
||||
Loading…
Reference in New Issue
Block a user