danyspin97 / wpaperd

Modern wallpaper daemon for Wayland
GNU General Public License v3.0
329 stars 25 forks source link

Contribution Guidelines #30

Open nosnebb opened 1 year ago

nosnebb commented 1 year ago

I want to start contributing features / tests / QA to this repo, but I don't see any guidelines for contributing and possibly a format for creating issues on your repo.

Think it would be a great idea to have some basic rules for contributors, tests, CI / CD pipeline, pull request format etc. Again, I'm happy to contribute my time to producing these things.

Also, this isn't my main github account as most of my programming experience is from using platforms like bitbucket / jira and another company entirely. Just trying to get involved

Thanks :)

danyspin97 commented 1 year ago

Hello @nosnebb and thanks for the report :)

I have not added contributing guidelines because the project is pretty small and I didn't think it was needed yet. I'll try to add them in the next future but it has currently low priority for me over features.

Regarding rules, there is a CI/CD pipeline and as long as that passes, that is enough for me. The domain is pretty hard to test so there is no test suite currently, but if anyone would like to add it, that would be a huge help.

I think that the first thing that we need is a format for creating issues, as you said. It should include current wpaperd version, distribution and current wm running (including version). I am not sure if we need a pull request format.

Any help on that is much appreciated :)