| ... | ... | @@ -12,6 +12,8 @@ Deterrence Dispensed uses a set of standards for quality product releases, and a |
|
|
|
| :page_facing_up: **README.md** | Yes | :heavy_check_mark: | documentation in the file of this template in Markdown format at the root of the package. [Click here for the required template](https://gitlab.deterrencedispensed.com/deterrence-dispensed/information-and-tutorials/-/wikis/For-Developers/Resources/Release-Package-Requirements/README.md-Sample) |
|
|
|
|
| :page_with_curl: **LICENSE.txt** | :no_entry: | 🔹* | A license for the products, files, and documentation in your release package (that belong to you/your organization). |
|
|
|
|
| :notebook: **Assembly Guide PDF** | 🔹 | :heavy_check_mark:* | Documentation in the file of this template in Markdown format at the root of the package. |
|
|
|
|
| :notebook: **Assembly Video** | 🔹 | 🔹 | A brief video demonstrating general assembly may be included, without narration |
|
|
|
|
| :notebook: **Build Guide Video** | 🔹 | 🔹 | A comprehensive video, demonstrating the entirety of the PDF through the build process, with narration, is strongly recommended. |
|
|
|
|
|
|
|
|
> **:no_entry:** indicates an item NOT to include.
|
|
|
|
|
| ... | ... | @@ -73,10 +75,14 @@ _Section under construction._ |
|
|
|
|
|
|
|
Through documentation, including assembly steps and photos should be included in a fixed document in PDF format.
|
|
|
|
|
|
|
|
> ⚠ **NOTE:** This requirement can be forgone if:
|
|
|
|
~~> ⚠ **NOTE:** This requirement can be forgone if:
|
|
|
|
> - a video assembly guide is created and included/linked with the release package
|
|
|
|
> - a video depicting assembly is linked online **where the assembly steps** are conclusively similar/identical between a printed and original, factory model.
|
|
|
|
> - a video depicting assembly is linked online **where the assembly steps** are conclusively similar/identical between a printed and original, factory model.~~
|
|
|
|
|
|
|
|
_Section under construction. See page discussing Assembly Guide PDF for information._
|
|
|
|
|
|
|
|
## 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.) |
