3. How do I submit code to the LAVA Code Repository?

[crelf]

We've had a number of people enquire about how to get their code into the LAVAcr. It's great to see that people are interested in submitting - we really would like to see the LAVAcr grow in its' early weeks so we can etablish a base to work from. There are currently two ways of getting your code submitted:

New submissions

If you have a submission that doesn't currently exists anywhere in LAVA (eg: it's not already in a thread somewhere), then use the LAVAcr submission form.

Existing submissions

The LAVAcr is the place for all the code you want to share, so we'd like to see some of the existing code that you've posted migrate across to the LAVAcr. If you've got a submission that's in this boat (you've already created a previous thread and want your submission moved over to the LAVAcr), please use the standard LAVAcr submission form, but also include a link to the existing thread in the submission notes - this allows the LAVA Certified assessor assigned to your submission to migrate the old thread across to the LAVAcr as well.

What Files to Include

All your files must be included in a single zip file. It is recommended to put the version number of your submission somewhere in the filename. Make sure you include all your vi's. Please do not submit or include LabVIEW toolkits or vi.lib files. If you are referencing OpenG vi's then please indicate what packages (names with version) are required. It is usually not recommended to include OpenG code with the submission.

You must include a readme.txt file inside the zip file. There is a template and instructions on how to create an acceptable readme.txt file here.

How to Use the Submissions Form

First you will need to select a category. Don't worry if a proper category for your submission does not exist. A LAVA Certified assessor will create one if necessary. If you can't find the right category, place it in the General category. A LAVA Certified assessor will move it to the right place when it's approved. Press continue after you select a category.

Now it's time to give your submission a name. This is the main name of your submission so please use something descriptive. For example: N Button Dialog With Fancy Graphics, instead of: nbd.zip.

Enter a description. The main download page will show the full description. The description field uses the same editor as the standard forum posts. The description field supports BBcode, which means you can add Bold\Italic. It also supports full html. Currently we don't support image attachments within the description, however as you will see later, you may add an image for your submission.

Log Example.zip

The version of the filename should be of the form major.minor.bugfix It is your choice on what version to start with but we recommend 1.0.0. On subsequent revisions of the file, all you need to do is update the file with the new revision and edit this field with the new number.

Select the LabVIEW version you used to program your submission. As you can see, bugfix revisions of LabVIEW are ignored and are not important at this point.

CaseSelect.zip

Please pick a license. More information on licensing and the LAVA policy on licensing is found here. You always have the option of using your own license not listed here. If this is the case please include it within your submission zip file as a license.txt file.

Click on the browse button to upload the zip file containing the code you want to submit. If you are editing an existing file and want to change the exisitng uploaded file with a new version then just browse to a new file and submit it. The old file will be replaced with the new one. This is a little confusing since if you come back to edit the file later, this field will always be blank. You will not see your old submission here.

BDWin.Open.vi

Please add a screenshot. This can be of the diagram, front panel, LabVIEW palette or any other descriptive part of your submission. Submissions without screenshots will be rejected. Please upload the image from your computer in the allowable format. Externaly linked files are not accepted.

Editing Your Submission After Approval

After your submission has been approved, you will receive a personal message informing you about this and your file will be available for download. A link to your submissions support topic will be created automatically in the appropriate forum. Please visit your thread to help others who are having trouble with your submission. You can find the link to your support topic at the bottom of your download page.

If you want to edit your submission (upload a replacement file or change description) then all you need to do is click on the Edit this file link on your submission download page:

Future revisions of your files don't need to be re-approved but make sure you are still maintaining compliance since a member of the LAVA Certified assessor team will periodically review submissions in the LAVAcr for compliance.

Only through sharing will we all learn together,

The LAVAcr Team

Download File:post-2-1160472731.txt

[Phil Duncan]

The LAVAcr is the place for all the code you want to share, so we'd like to see some of the existing code that you've posted migrate across to the LAVAcr.

I think this is an excellent idea.

Some thoughts...

You want ALL shared code to go to the repository and all submitted code will be evaluated against the LAVAcr standards. I understand the reasons for evaluation, but as you mentioned the evaluation process is administered by volunteers. My point ? Some of the code submitted in response to questions is just a "quick & dirty" explanation of how to achieve a desired result and would probably not pass the LAVAcr review process. In these instances I would not wish to waste the code reviewers' time and hence would no submit the code to LAVAcr. Should we then only e-mail the quick and dirty code to the user and maybe provide a screen shot for the forum or is there a more appropriate process we should follow?

Cheers & Beers

:thumbup: & :beer:

[Michael Aivaliotis]

...Some of the code submitted in response to questions is just a "quick & dirty" explanation of how to achieve a desired result and would probably not pass the LAVAcr review process. In these instances I would not wish to waste the code reviewers' time and hence would no submit the code to LAVAcr. Should we then only e-mail the quick and dirty code to the user and maybe provide a screen shot for the forum or is there a more appropriate process we should follow?

Cheers & Beers

:thumbup: & :beer:

There seems to be a misunderstanding since we probably didn't clarify this point. Our fault not yours .You will still, as always, continue to attach code and files to your forum posts. This hasn't changed and will not change in the future. Sometimes however, a reply to a support topic may trigger you to come up with a tool or a complete set of VI's that are cleaned up for the general public. If you were to post it to the same thread then it would get buried in the noise. The LAVAcr helps organize those gems so people can find them and ask for support when they download it and have problems. Don't be afraid to submit code to the LAVAcr we aren't as strict as you might think.

As far as emailing the person the code, this seems backwards. The whole point of the forums is to educate, and hiding the discussions and code exchange defeats this. So, YES attach your code to your reply AND post an image (for those that don't have LV:8.0.1)