question

laurenceh avatar image
laurenceh asked

How do I add to Victron GitHub what are the rules?

Should I add code contributions for the community as a new repository under https://github.com/victronenergy or under my own GitHub account?

(It appears I might be able to do that but don't want step on any toes or break rules)

Is there a guide adding code to the Victron GitHub location?

(I had a quick search and did not find anything, but perhaps I missed it)

If I have already aded a repository with my code in, is there a way to add the repository to a place where Victron Venus users can find it?

IM on a steep learning curve for GitHub as I only created my account 4 hours ago so any help / advice gratefully received!

Laurence

development
2 |3000

Up to 8 attachments (including images) can be used with a maximum of 190.8 MiB each and 286.6 MiB total.

1 Answer
Thiemo van Engelen (Victron Energy staff) avatar image
Thiemo van Engelen (Victron Energy staff) answered ·

Hi @LaurenceH

The default way of working is forking a repository from https://github.com/victronenergy to your own account and then making changes there. When you think you have something that is useful for Victron, you can send a pull request (see https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork ).

Also a good way to contribute to Venus development is participating in the victron-dev-venus google group (https://groups.google.com/g/victron-dev-venus). This can be used to pitch ideas and improvements and is a good place to get ideas and feedback from other enthusiasts that are developing for Venus.

Kind regards,

Thiemo van Engelen


1 comment
2 |3000

Up to 8 attachments (including images) can be used with a maximum of 190.8 MiB each and 286.6 MiB total.

laurenceh avatar image laurenceh commented ·

Thiemo

thanks for replying, I had a look - I'm still trying to understand GitHub.

I can see how I could fork a repository and add to that exiting repository but each one in github.com/victronenergy already has its own README.md, LICENCE files and code directory, so I dont want to modify (or contribute) to an existing project.

It seems that I think I need to do is add my own repository (probably called dbus-i2c or dbus-temperature or something that) With my own README.md of instructions my own LICENCE file and my own code directory.

I could fork an existing project as you say, and then edit all my stuff (including instructions) into a sub directory of one of the existing repositories, but which one ? - What I have written is a service, most similar to dbus-adc but my service interface code is in Python whereas dbus-adc is in C. - Please let me know if this would be the best place to do it?

One the other hand, it seems to it properly, you could either;

Thanks Laurence

0 Likes 0 ·