search

anufrievroman / waypaper

GUI wallpaper manager for Wayland and Xorg Linux systems
https://anufrievroman.gitbook.io/waypaper
GNU General Public License v3.0
277 stars 11 forks source link

Add contribution instructions to README and improve code documentation #49

Closed nikolaizombie1 closed 1 month ago

nikolaizombie1 commented 1 month ago

I would like to create instructions on how to contribute to waypaper so that it is easier for future contributors to get started implementing their additions to this project. Along this same vein I would also like to document the code base primarily through doc strings to ease the process of familiarization of the code base. Would this be advisable?

anufrievroman commented 1 month ago

Great idea. If you want to contribute to the documentation, you can make PR to this repository: https://github.com/anufrievroman/waypaper-docs (which mirrors to gitbook website).

If you feel like some doc strings require more information, please also feel free to extend them. I wrote most of them as concisely as possible, mostly for myself, so I guess many of them are not enough for someone else to quickly understand the code.

nikolaizombie1 commented 1 month ago

Great idea. If you want to contribute to the documentation, you can make PR to this repository: https://github.com/anufrievroman/waypaper-docs (which mirrors to gitbook website).

I will be working on this shortly.

If you feel like some doc strings require more information, please also feel free to extend them. I wrote most of them as concisely as possible, mostly for myself, so I guess many of them are not enough for someone else to quickly understand the code.

It's mainly in the function signatures that lead to a lot of initial confusion. For example, what is cf or txt. What type is monitor in change_wallpaper and so on and so forth. I will be working on this as well.