jerboa icon indicating copy to clipboard operation
jerboa copied to clipboard

Add PR template that informs the reader about formatKotlin

Open MV-GH opened this issue 1 year ago • 7 comments

Basically title, add a template for pull requests that informs the reader that the reader shouldn't forget to do ./gradlew formatkotlin

MV-GH avatar Jun 13 '23 20:06 MV-GH

Better approach would be to have a pre-commit hook that executes it maybe?

kuro-codes avatar Jun 14 '23 13:06 kuro-codes

I am not opposed to that either way it should be mentioned in CONTRIBUTING.md

MV-GH avatar Jun 14 '23 14:06 MV-GH

It needs to be documented either way. In my experience even if you have a pre-commit config most users won't use it.

twizmwazin avatar Jun 14 '23 18:06 twizmwazin

I like the idea of setting up a basic CONTRIBUTING.md, just mentioning this and any other practices/conventions we want to adhere to along the way.

a1studmuffin avatar Jun 15 '23 05:06 a1studmuffin

Yes, a contributing doc would be nice

kuro-codes avatar Jun 15 '23 06:06 kuro-codes

Other things that would be good to mention:

  • when to bump the settings database version
  • making changes to strings.xml files (to make localisation changes easier to manage)

a1studmuffin avatar Jun 15 '23 08:06 a1studmuffin

It needs to be documented either way. In my experience even if you have a pre-commit config most users won't use it.

https://github.com/jeremymailen/kotlinter-gradle#git-hooks

it's possible to force add them on build

MV-GH avatar Jun 19 '23 11:06 MV-GH