search

luisbocanegra / plasma-smart-video-wallpaper-reborn

Smart Video Wallpaper for KDE Plasma 6
https://store.kde.org/p/2139746
GNU General Public License v2.0
45 stars 1 forks source link

Contributing Guide #16

Open dupontinquiries opened 2 months ago

dupontinquiries commented 2 months ago

Hey this applet you made is awesome. Could you add some documentation on how to contribute? I have a similar project I have been using that is a webpage equivalent of this and I think you have a good codebase but I also really like some of the small features my current solution has and was wondering about the best way to try and incorporate code or suggestions into the project. Maybe adding a short CONTRIBUTING.md or something like that would be good, or maybe you don't mind me sharing javascript code in an issues thread. Please let me know.

luisbocanegra commented 2 months ago

Hi, for contributing it would be the common:

  1. Fork this repository.
  2. Install the dependencies. I think cmake extra-cmake-modules libplasma (or equivalents, this is for Arch Linux) would do.
  3. Test installing the project.
  4. Make your changes addressing one thing at a time with meaningful commit messages.
  5. Update the README or config template as needed.
  6. Send a pull request, short and concise focused in one aspect of the project.

For testing changes I just run ./install.sh; systemctl --user restart plasma-plasmashell.service

I will put that in a CONTRIBUTING.md file, thanks for the suggestion.

If you have any questions about how something works or how something could be implemented let me know and I will try my best to help.

maybe you don't mind me sharing javascript code in an issues thread

It's fine as long as it isn't a modification to my code, for that a link to a commit is preferable. If the code you want to incorporate/suggest is uploaded somewhere it would be better to link that. Otherwise make sure you use code blocks