Q: how to submit a theme

I made a theme for v6, i’ve put it on gitlab.com there’s a validator tool that says my .zip and metadata.json is “okay”

now, the remaining steps are probably very simple to git samurais, but i’m not one, i barely use git via “git gui” for my own projects.

can one of the git gurus guide me?
i tried some stuff but it didn’t work and i think i have to “fork” the whole “metadata” subproject to my account first?


perhaps the documentation/instructions about contributing to the PCM aren’t very noob-friendly.
while it’s true that i’m a “coder” and i should probably know how to deal with git (that’s my fault), i can imagine a non-coder guy making some awesome color theme…

See KiCad Addons | Developer Documentation | KiCad, search for “Submitting your package”

  1. First create a gitlab account if you don’t have one.

  2. Sign in and fork the package metadata repository, there is a button for that.

  3. Setup your gitlab account so you can push to your newly created fork ( Use SSH keys to communicate with GitLab | GitLab )

  4. In the folder of your choice, clone your newly created gitlab repository using the address you can see when clicking on “Clone” ( command line: git clone *address* )
    image

  5. if you intend to make other submissions in the future, I would recommend to create a new branch git checkout -b *branch_name*

  6. Add your files / make the changes as the guidelines tell you to

  7. Commit your files ( you need to git add *file* then git commit )

  8. Push the files to your remote ( git push )

  9. Open a merge request

EDIT : for 8, the merge request should be targeting the official repository, not the one you created.

Of course, you could do all git command lines using the GUI of your choice.

2 Likes

thanks a lot
so i followed that and the validation failed:

I think your screenshot is from gitlab automated tests ?
What step are you currently at ?

I can’t see your fork here ( KiCad / KiCad Addons / Package Metadata · GitLab ) is it private ? Or are you using a different username ?

hm, i thought i chose Public… it’s public now
and the validation… succeeded, i guess?

now i tried the Merge thing and… i can’t really tell what happened, i ended up on this page:

Almost good, you made the merge request against your own main branch, but you what you really want to do is to do it against the official main branch.

Use the button here Merge requests · KiCad / KiCad Addons / Package Metadata · GitLab
( note that you can see it is the official one thanks to this :
image
)
And be sure that the target branch is set as follow:

The page you saw ( and the one you will see once the target branch is correct ) is where reviewers are able to review your addition. Once it is done, you just have to wait for comments.

PS : maybe the validation failed because it wasn’t public, so the script could not fetch the data.

i guess… it’s done now

thanks a lot


hopefully someone else would find this useful (i would certainly come back and re-read it next time i submit something)

This topic was automatically closed 90 days after the last reply. New replies are no longer allowed.