Skip to content

README: add good practices for forking, porting or rewriting VESC Tool - #472

Merged
vedderb merged 1 commit into
vedderb:masterfrom
RageMechanics:readme-good-practices
Oct 14, 2026
Merged

vedderb merged 1 commit into
vedderb:masterfrom
RageMechanics:readme-good-practices

Conversation

@RageMechanics

Copy link
Copy Markdown
Contributor

As suggested on the VESC Discord, this adds the "good practices" summary for projects that fork, port or rewrite VESC Tool (e.g. in Rust, Flutter or for the web).

It is inserted right after the existing "Forks without branding" paragraphs; nothing else in the README is changed. It covers:

  • GPL-3.0-or-later obligations for derivative works (notices, source, About screen, dependencies)
  • Naming, logos, icons and visual identity under the trademark policy
  • App identifiers, update checker and UI wording
  • How to state compatibility, an About/credits template, distribution, and a short checklist

Feel free to edit or trim the wording directly.

@github-actions

Copy link
Copy Markdown
Contributor

CLA Assistant Lite bot:
Thank you for your submission, we really appreciate it. Like many open-source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution. You can sign the CLA by just posting a Pull Request Comment same as the below format.


I have read the CLA Document and I hereby sign the CLA


You can retrigger this bot by commenting recheck in this Pull Request

@RageMechanics

Copy link
Copy Markdown
Contributor Author

I have read the CLA Document and I hereby sign the CLA

@vedderb
vedderb merged commit c06f1cb into vedderb:master Oct 14, 2026
1 check failed
@github-actions github-actions Bot locked and limited conversation to collaborators Oct 14, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants