familie-hoppe/CONTRIBUTING.md
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

1.1 KiB
Raw Blame History

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