dwl-patches

• A general dwl wiki is available at the main dwl page.
• This repository is exclusively for dwl PATCHES.

STALE Patches

Many patches previously in regular use do not cleanly apply to the current code base. Following the migration to Codeberg, these stale patch descriptions and details are being stored for the time being at _STALE_PATCHES.

If you are an original author of one of these or you have the inclination to revive one of these, please follow the procedure outlined in [Instructions] for contributing new patches.

Additionally, when you have write access to this repository, remove the .md file from _STALE_PATCHES for the patch which you have revived.

Patching

Since dwl follows suckless philosophy it doesn't provide every feature under the sun. To broaden dwl's functionality, one needs to get familiar with the concept of patching. To get your feet wet, consult the hacking page of the suckless website.

Since dwl is still taking shape, patches may need to be updated after larger changes to the code. Feel free to contribute updated versions!

Note: These external patches are user-submitted content, and the authors of dwl cannot monitor them. Please download and review a patch before using it!

Reporting Issues

• Issues with existing patches can be generated here in the dwl-patches issues. Please be sure to "@" reference the patch author in your issue.

Creating Patches

1. Create a Codeberg account and fork the dwl repository.
2. Create a branch in your Codeberg dwl repository for the patch you are generating and maintaining.

Contributing Patches to dwl-patches

1. If you do not have it already, add the remote for the main dwl repository in your local copy:
   git remote add upstream https://codeberg.org/dwl/dwl

2. In your local repository of dwl, create a .patch file
   git format-patch upstream/main...<branch-name> --stdout > PATCHNAME.patch

3. Fork https://codeberg.org/dwl/dwl-patches

4. Configure your repository
   git config --local pull.rebase true

5. In your local copy, add a directory called patches/PATCHNAME. Place the PATCHNAME.patch you created in step three into the patches/PATCHNAME directory.

6. Use the Codeberg web interface to send a pull request to dwl-patches (NOT to dwl) (Codeberg nicely will generate a URL for you)

7. Add a README.md page to the PATCHNAME directory using this template (add/remove sections as you like):

   ### Description
   Insert a short summary of changes that your patch implements.
   
   ### Download
   - [git branch](https://codeberg.org/USERNAME/dwl/src/branch/PATCHNAME)
   - [yyyy-mm-dd](https://codeberg.org/dwl/dwl-patches/raw/branch/main/patches/PATCHNAME/PATCHNAME.patch)
                                              USE THE ^raw^ PATCH LINK HERE
   ### Authors
   - [YOUR_NICK](https://codeberg.org/USERNAME)
   

   You may choose to include screenshots (hosted in your patch's subdirectory) in your README.md. The process is described here.

8. WHEN YOUR PULL REQUEST IS APPROVED, your Codeberg account will also be granted commit access to dwl-patches. Once you have write access, you can make direct modifications/upates to your patches instead of pull requests.

Updating/Modifying Existing Patches

• If the existing patch is already being maintained by another author, do not make modifications to it without permission.
• Create an issue at issues @mentioning the current maintainer
• If you receive no reply for seven days, you may adopt the patch. If you are adopting the patch, you need to maintain a dwl branch in your Codeberg repository.
• Modify the README.md with new links for your raw patch and for your git branch. LEAVE PREVIOUS AUTHOR(S)' NICKS/LINKS INTACT UNDER THE "Authors" HEADING! Add your own nick/link to the top of the "Authors" list.