Alex CTRLPewDeterrence Dispensed uses a set of standards for quality product releases, and as such, we define a minimum-viable product release package with the contents as listed below:
| Directory/File | Required for beta? | Required for release? | Description |
|---|---|---|---|
|
|
|
Supplementary documentation for particularly involved assemblies | |
|
|
Native editor binaries | ||
|
|
3D renders or real-world images of the product | ||
|
|
n/a | A collected of user-submitted remixes. Only applicable if your initial release is to include user submissions. | |
|
|
STEP file exports of the assemblies (whole product) or assembly variants | ||
|
|
STEP file exports of reference CAD models used to support design of the printed model | ||
|
|
Yes | STL file exports of every printable object, including a blank STL version with no branding or texturing | |
|
|
Yes | Documentation in the file of this template in Markdown format at the root of the package. Click here for the required template | |
|
|
|
A license for the products, files, and documentation in your release package (that belong to you/your organization). | |
|
|
|
Documentation in the file of this template in Markdown format at the root of the package. A sample can be found here. | |
|
|
A brief video demonstrating general assembly may be included, without narration | ||
|
|
A comprehensive video, demonstrating the entirety of the PDF through the build process, with narration, is strongly recommended. |
⛔ indicates an item NOT to include.
🔹 indicates an optional item.
✔ indicates a required item.
* indicates additional conditions and elaborations as described in this process guidance document.
📁 Documentation
Use this folder to store extra documentation or history for your project, if you wish to include it. Ideally, the PDF/assembly guide should be a conclusive piece of documentation, but if your project is complex and requires distinct and discrete guides, this folder is the place to put it.
📁 Native
The Native folder is used for storing complete assemblies in the format used by the editor of the author's choice. This may include SolidWorks assembly files, Fusion360 exported assemblies, or Inventor IPTs.
Be sure to include referenced assemblies in the native export as well, and resolve any dependencies.
📁 Renders
The Renders folder should include images (in PNG or JPEG format no larger than 10 MB) that would be used for media releases and thumbnails for indexes. Ideally, they are a collection of real-world pictures, and 3D renders/screenshots.
⚠ IMPORTANT! Before even committing any image files (especially JPEGs) to your repo, be sure to REMOVE and SCRUB your files for any EXIF data. This data can be used to identify you and your location!
📁 Remixes
The release package can contain user submitted remixes. Remixes must be organized by username in folders, of which contain the files in a similar structure to the release package (STL, STEP, Renders, etc.).
The requirements for a remix submission are relaxed- as long as they are derived from the latest release candidate before release.
The Remixes folder must have a release index, using this format.
📁 STEP
The STEP folder should have an exported, complete assembly from your editor. This is NOT the same as a native file- the STEP files are a universal CAD format recognized by many CAD applications out there.
A single STEP file containing an entire assembly is recommended, however, if there are variants to an assembly, a STEP file of each variant is strongly recommended.
📁 STL
The STL folder should include the exported mesh files from your CAD editor. These will the files used for a slicer for 3D printing.
One unique requirement for the STL folder is that parts of an assembly meant to be printed must be saved as a separate STL file.
📄 README.md
The README.md file is essential to accurately describe to our internal indexing and documentation workflow, as well as providing a parse-able file for GitLab and other indexing services to display.
You can find an up-to-date template here. YOU MUST USE THIS TEMPLATE.
📃 LICENSE.txt
As a creator you have rights to you project. A license specifies rights you are giving away. Creative Commons has many such examples. If you do not specify a license you give no rights away.
📓 Assembly Guide PDF
Through documentation, including assembly steps and photos should be included in a fixed document in PDF format.
⚠ NOTE: This requirement can be forgone if:
- the current release is a derivative of a previous release that has a PDF
- assembly of the TYPE or PLATFORM of the release is considered common knowledge. (Such an an AR-15 or Glock platform)
A sample .docx template of a PDF can be found in the wiki here.
Important Notes
-
All releases, including revisions to released items even before this specification, must be compliant with the package requirement outlined above.
-
All releases will undergo a review/pull request process to provide subjective feedback and corrections for the "human touch" in quality. (That means that you might have further feedback after you fulfill the checklist.)