diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..3dab0ed --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,26 @@ +# Contributing to lowfi + +There are a few guidelines outlined here that will make it more likely for your PR to be accepted. +Only ones that are less obvious are going to be listed. If you need to ask, it's probably a no. + +## 1. No AI + +You can use AI for searching and so on, and if there's something minor and tedious that you'd like +the AI to write then that's okay, but if it is noticable that you used AI then it is way too much. +If you used AI, you aren't helping any maintainer by submitting your slop, it's just a hassle for them. + +## 2. Smaller is better + +Try and make it so that each PR is one contained feature. Adding multiple features in a PR is usually a bad idea. +This is also so that individual features can be approved or denied, rather than that having to be for a more significant +chunk of code. + +## 3. Keep lowfi simple + +lowfi is supposed simple program. For now, no changes to the initial user-facing UI will be accepted. +The UI of lowfi playing a song has stayed identical since the first versions, since complicating it +detracts from it's purpose. + +More complex features, like fancy colors or cover art, will not be accepted ever. Implementations of +acceptable features should also be simple and not too obtrusive. Even if a feature is simple, +if it is very complex to implement, then it won't be accepted.