F.A.Q. - Developers

Q1

How can I get a project hosted on VLCore?

A: For getting your project hosted here please submit an Issue. You don't need to be a professional programmer or developer, contact us and we will get you started.

Q2

I'm new to git/hg, how can I get started with revision control systems?

A: You can read complete and free online editions of printed books from Apress and O'Reilly Media on these topics. Apress provides "Pro Git" for git, while O'Reilly Media provides "Mercurial: The Definitive Guide" for hg. TODO: Add git/hg quick-start links.

Q3

I want to add feature foobar to project XYZ, how do I proceed?

A: There are a few different options that you have.

1. The preferred method is to create a fork from the VLCore XYZ repo. This will make a clone of the repo under your user account, that you have full control over. After you have completed the necessary additions for foobar, do a pull and merge from the VLCore XYZ repo. This will update your fork to have the latest changes done to the VLCore XYZ repo, and merge in your feature so it can be submitted. Afterwards, issue a Pull Request to notify the VLCore repo that your foobar modification to XYZ is ready.
2. If you have write permission on the VLCore XYZ repo, you can clone directly from it to your hard drive. After you have made your changes to incorporate foobar you will need to pull and merge as with Method 1. Afterwards, you can push directly back to the VLCore XYZ repo.
3. Submit a patch. (See #Q4 Below.)

Q4

What if I just have a quick modification I want to send in?

A: If you don't want to do the rounds with git/hg and the push/pull routine, it is ok! You can simply add a patch as an attachment to an Issue. For more info on creating and submitting patches, see HowTo/Patch.