search

skraus-dev / cherryrgb-rs

Cherry RGB Keyboard - Multi platform tool to set RGB LEDs for Cherry keyboards
MIT License
41 stars 3 forks source link

Contribution guidleines #23

Closed luv4bytes closed 1 year ago

luv4bytes commented 1 year ago

Maybe set up contribution guidelines. Like rules for writing tests etc.

skraus-dev commented 1 year ago

Alternative: I stop being so nitpicky :)

luv4bytes commented 1 year ago

That's not the reason 😂 I just thought maybe set some basic rules for contributions. But feel free to close the issue :)

skraus-dev commented 1 year ago

I honestly cannot set any specific guidelines, as I am not feeling advanced enough in the programming language used here to set something like "best practices for contributing". It's my first rust-based project that got an actual userbase :D

I will keep this issue open tho, to remind me to create "Bugreport" and "Feature request" issue templates at some point.

mpldr commented 1 year ago

Alternative: I stop being so nitpicky :)

Not a good alternative. Compromising on quality is a corporate thing to do. My advice would be to take a looks at similar contribution guidelines. :)

Exhibit 1: https://lists.sr.ht/~rjarry/aerc-devel/patches?search=%22column+based+index+format+with+templates%22 Exhibit 2: https://git.sr.ht/~rjarry/aerc/tree/master/item/CONTRIBUTING.md

skraus-dev commented 1 year ago

Did start with adding templates for issues/pull requests, small note on commit message format and formatting / testing.

If you have topics to contribute to the CONTRIBUTING.md document, feel free to propose them there.