Skip to content

Latest commit

 

History

History
160 lines (107 loc) · 2.93 KB

HACKING.md

File metadata and controls

160 lines (107 loc) · 2.93 KB

Plank Reloaded - Development Guide

Testing the Latest Build

The latest stable version can be installed via your distribution's package manager or built from source.

Getting Help

For Plank Reloaded specific issues and discussions:

Contributing Without Coding

  1. Report and Verify Issues

    • Check existing issues on GitHub
    • Report new bugs with detailed information
    • Help verify and test fixes

  2. Documentation

    • Help improve documentation
    • Update wiki pages
    • Suggest improvements

Building From Source

  1. Clone the repository:
git clone https://github.com/zquestz/plank-reloaded.git
cd plank-reloaded
  1. Build and Install:
meson setup --prefix=/usr build
meson compile -C build
sudo meson install -C build
  1. Run Plank:
meson compile -C build run

Debugging Issues

For investigating crashes or memory issues, use GDB:

meson compile -C build run-debug

Development Guidelines

Bug Fixes and Features

Important: Keep fixes for different bugs in different branches!

  • Create a separate branch for each bug fix
  • Branches fixing multiple unrelated bugs will be rejected
  • Exception: Patches that are indivisible by nature

Reasons for this policy:

  1. Prevents delays when some fixes need revision while others are correct
  2. Allows selective reverting of problematic changes
  3. Makes code review more focused and efficient

Git Workflow

Initial Setup

  1. Fork the repository
git clone https://github.com/YOUR-USERNAME/plank-reloaded.git
cd plank-reloaded
  1. Add upstream remote
git remote add upstream https://github.com/zquestz/plank-reloaded.git

Making Changes

  1. Create a feature branch:
git checkout -b fix-issue-number
  1. Make your changes and commit:
git add <files>
git commit -m "Descriptive message"
  1. Keep your fork updated:
git fetch upstream
git checkout main
git merge upstream/main
git push origin main
  1. Update your feature branch:
git checkout fix-issue-number
git rebase main
  1. Push your changes:
git push origin fix-issue-number
  1. Create a Pull Request
  • Visit your fork on GitHub
  • Click "Pull Request"
  • Select your feature branch
  • Describe your changes
  • Submit the PR

After Pull Request Review

If changes are requested:

  1. Make the required updates
  2. Commit new changes
  3. Push to your branch
  4. The PR will update automatically

Tips

  • Write clear commit messages
  • One logical change per commit
  • Keep PRs focused and reasonably sized
  • Follow the coding style guidelines
  • Add tests for new features
  • Update documentation as needed

License

This document is licensed under the GPL version 3.