Contributing

Thank you for your interest in improving this textbook! I welcome contributions from the community.

How to Contribute

Reporting Issues

If you find errors, typos, or unclear explanations: 1. Go to the Issues page 2. Click “New Issue” 3. Provide a clear description and page reference

Suggesting Changes

To propose changes to the content:

  1. Fork the repository - Click “Fork” at the top right of the repository page

  2. Clone your fork:

    git clone https://github.com/YOUR-USERNAME/ebook.git
cd ebook

  3. Create a branch:

    git checkout -b fix-typo-chapter-3

  4. Make your changes - Edit the .qmd files in the chapters/ directory

  5. Commit your changes:

    git add .
git commit -m "Fix typo in Chapter 3, section 2"

  6. Push to your fork:

    git push origin fix-typo-chapter-3

  7. Create a Pull Request:

    • Go to the original repository on GitHub
    • Click “Pull Requests” → “New Pull Request”
    • Click “compare across forks”
    • Select your fork and branch
    • Provide a clear description of your changes

Guidelines

  • Be specific: Reference exact locations (chapter, section, line number if possible)
  • Be respectful: All contributions should maintain a professional, educational tone
  • Test if possible: If adding code examples, ensure they run correctly
  • One topic per PR: Keep pull requests focused on a single issue or improvement

Questions?

Feel free to open an issue for questions or reach out to sk818@cam.ac.uk

Thank you for helping improve this resource for the energy informatics community!