Jump to content
Sign in to follow this  
Michael Aivaliotis

How does the Code Repository work?

Recommended Posts

Note: Detailed submission procedure can be found here.

LAVA Certified

All LAVAcr content is LAVA Certified - a certification that insists on appropriate quality, support and usefulness. Members cannot simply upload any type of code to the LAVAcr - it must adhere to specific standards and rules before it is considered for inclusion. All code submitted is moderated by a group of well-respected LabVIEW professionals, all of whom are also respected premium members of LAVA.

What is LAVA Certified?

All LAVAcr submissions are assessed based on LAVA Certified criteria, including appropriateness for the LAVAcr environment. Although this may sound daunting, making sure your submissions are LAVA Certified is really just a matter of common sense and the standard practices we have all come to expect from competent LabVIEW developers. For code to become LAVA Certified, it must adhere to the following requirements:

  • All custom VIs must include an appropriate level of documentation: including the use of the VI Documentation, free text on the Front Panel and/or Block Diagram. You don't need to include a novel, but please consider the average level of knowledge of a LabVIEW programmer that has never seen your code before.
  • A verbose description is expected on the submission web page: this will form part of the page where your code will reside.
  • Error handling must be appropriate: If your code has an error in cluster, then chain errors through your code to an error out cluster. If you're providing code that may be used as a subVI, then enclose all of your code in an error case structure.
  • Your style does not need to be perfect: but consider those who will be trying to understand and perhaps modify your code. Keep crazy wiring to a minimum, try to line subVIs up, give VIs meaningful icons, use the 4-2-2-4 connector layout when you can, etc.
  • All submissions must be versioned.
  • Incomplete or secure code will not be accepted: including code with locked diagrams, missing diagrams or password protection.
  • You must take reasonable steps to confirm that your code conforms to the functionality you submit it under.
  • You are the primary support vehicle for your submitted code: and you must stand behind it. If another LAVA member has questions and/or comments, you must make yourself available within a reasonable amount of time to help out. Each portion of code will have a dedicated support thread, and other LAVA members may try to assist too, but you own the code, so it's your responsibility.
  • LAVA Certified assessors will not alter your code to make it meet the requirements: If a submission does not meet the requirements when it is assessed, it will be returned to the member with a short description on the requirements it failed to address.
  • Submissions must state the LabVIEW version it was created with: If you would like your code to be listed under more than one version of LabVIEW, then you must provide an extra copy in the appropriate version. You must confirm that your code works appropriately under each version of LabVIEW that you submit it for.
  • LAVA Certified code hosted in the LAVAcr must be bound by a software license of your choosing. A description of the license used must be included in the readme file of the submission. You must also include your contact and ownership information. Currently, we only accept code licensed under an Open Source License. The submissions form currently supports the following licenses which you can chose from:

BSD

GNU Public

Lesser GNU Public

Creative Commons Attribution 3.0

Creative Commons Attribution-Share Alike 3.0

Creative Commons Attribution-No Derivative Works 3.0

Creative Commons Attribution-Noncommercial 3.0

Creative Commons Attribution-Noncommercial-Share Alike 3.0

Creative Commons Attribution-Noncommercial-No Derivative Works 3.0

MIT

Other (included with download)

What is the Process for Submitting my Code?

Code is submitted by filling out a dedicated web form here. This form requires some information from you (including a functionality description, image, desired distribution license), as well as a place to upload you code. More information about the submission procedure with a video can be found here. Once you have submitted the code, it will automatically get placed in the uncertified category and is immeadiatly available for download on LAVA. Once the review process is complete, you will receive notification whether you submission has been accepted and included in the certified LAVAcr categories, or if it has been denied based on the LAVA Certified requirements.

How long does it take for my submitted code to be considered "certified"?

That's an easy one: it depends smile.gif The LAVA Certified assessment team are donating their time to this cause, so it may take a while (we aim to average next-business day). Try to find comfort in that good things come to those who wait.

What Happens if my Code is Denied?

We here at LAVA are people, just like you, and we don't want to exclude anyone, but making the LAVA Code Repository a free-for-all defeats the purpose of having a premium resource where other users can be confident that the contents are of a high quality. If one of the LAVAcr assessors deems that your submission doesn't meet all of the LAVA Certified requirements, then you will be emailed with a list of items that are considered erroneous. You are more than welcome to address the issues and resubmit the code. If you believe that your code is compliant with the LAVA Certified requirements and it is still rejected, please contact the assessor directly with your concerns.

  • Like 1

Share this post


Link to post
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Guest
Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.

Sign in to follow this  

×
×
  • Create New...

Important Information

By using this site, you agree to our Terms of Use.