search

eclipse-kuksa / kuksa-android-companion

Apache License 2.0
3 stars 1 forks source link

Readme: Removed misleading mentioning of Android Autotmotive #59

Closed SebastianSchildt closed 6 months ago

SebastianSchildt commented 6 months ago

Basically removed the mention about "Android Automotive" as this app does not rely in VHAL but enables KUKSA on any Android device.

Also fixed Markdown formatting/linitng issues, as it was hard to edit due to some hard linebreaks at random places

Chrylo commented 6 months ago

@SebastianSchildt Commitlint is currently failing. I can correct it if you want but a force push is necessary because the message is too long. Since we are already doing a force push, could you change the "fix" in the first commit to "docs" so this commit does not populate an entry for bug fixes. Also The commit message has to start with upper case after "docs". :)

You can use a recommended branch naming like task-59 / feature-59 / fix-59 if you want this also locally checked.

Don't forget to install the necessary tools defined by the repo if you want this support. ;)

Last point: For traceability reasons we require a linked issue to any PR. This will result into automatic linking inside the release notes and it also clearly states the issue which needs to be fixed (Important for more complicated issues). (I can create one since I understand the issue just fine :D but just FYI).

yarn install --frozen-lockfile

Sounds a lot but it should just take a minute. :) Just say if you want me to correct it or do it yourself.

SebastianSchildt commented 6 months ago

Installed it already, but could not get it to run. I mean except Not a protected branch - Ignoring pre push validation it did not do anything, Probably it does not work when rebasing, and I need to somehow recreate the branch and stage the changes afin. Anyway, ran out of time. 5 min to fix readme 20 mon figthing with the issue.

Is there any way to just manually run the check either by piping the logs or telling it which commits to check? That would simplify things

wba2hi commented 6 months ago

One more note from my side:

Whatever changes are decided to be taken here, please also align the fastlane/.../full_description.txt because this is what is reflected by F-Droid and lazily copy pasted from README.md

Chrylo commented 6 months ago

The reason for Not a protected branch is the branch name. :) It should also work with rebasing. You can either rename it locally to feature-x etc. or run

echo "fix: My great commit message" | yarn commitlint