---
# System prepended metadata

title: 'Seminar week 7: Release and versioning'

---

# Seminar week 7: Release and versioning
## Participants
|initials| name | discord user |
|---|---|---|
|JU | Jose Urra| jurra |
|SI| Santosh Ilhamparuthi| |
|NH| Nanami Hashimoto| Nanami |
| NA | Nemo Andrea | sandcrawler
|PO| Pepe Ocampo | jossoca |
|SR|Sara Reichert|sarara
|||
|MO |Mohammad(not present)  |moeb8001
# Icebreaker

# Exercises

## Exercise 1: Define what kind of release you are working towards
:::warning
Your comments bellow
I am personaly not working on any release, but going to through the documents to learn and apply it to my future projects.
:::

    Moh: I am personnally working on a release that lies in the "experiment/hack/build" category. In regards to its Lifecycle and continuity I would consider it mainly a one time release but at the same time open to feedback and any suggesstionson how to improve it.

    NH: I am currently working on a release that lies in the "An experiment/hack/build" category. It will likely be a one time release, but I am open to receive feedback from the users and make minor updates.
    
> Nemo: I made a first release of [SpotiStation](https://github.com/NemoAndrea/SpotiStation/releases/tag/v0.1.0), to signal that the project is ready for reproduction and that now a phase of testing and possible feedback can occur - as discussed in the notes.
> For the PCB project I am working on a `An alpha prototype meant to get feedback from early adopters`. I hope to get a first prototype out as soon as possible (hopefully have hardware be mostly final) - and then improve the code for the project in later releases (maybe with contributions from others).
    
## Exercise 2: Make a release checklist that you can easily incorporate as tasks in a project board
:::warning
Your comments below
:::


::: spoiler Moh
```
# Release planning notes
## Release notes
- status of the project: Almost done. Some important files still need to be uploaded (some CAD models and codes are not fully completed).
- Feateures implemented: TBD
#checklist:
-The device works perfectly. Y/N
-The project and the files have been peer reviewed atleast once and the feedabck was implented wherever needed. Y/N  






## License(s) for different modules of the project
#checklist:
- It includes a proper license. Y/N
 
 

## Bill of materials
-Electronics => Dupont jumper kables
                Raspberry Pi
                Pi camera
                
-Parts => 3D printed  

#checklist:
-The bill of material includes all the things needed for an average reader to build the set up from scratch. Y/N
-The material listed are enough to build an identical product. Y/N




## Assembly instructions
#checklist:
- Others (friends/family) found the instructions mentioned in this section cleear. Y/N
- The reader does not need prior knowledge to undertand the steps taken. Y/N
-The reader does not need prior coding experience. It is explained what each file is responsible for. Y/N

## Source files
-CAD files of all components.
-Python Codes (+links to the lubraries used).
#checklist:
 -Does it include all the libraries and the code used? Y/N
 -Are all the necessary CAD files available and easy to access? Y/N
 -Is credit given wherever it was due? (eg. youtube programming tutorials)
 -File names are not confusing. It is clear each file is for what. Y/N
 
 


## Resources and materials needed to re-use and or work in the project
-3D printer



## User Docs
- Select documentation medium
- Your documentation package in a sharable format
- The documentaation package is easilly accesible.


https://github.com/moeb8001/facetrackingcamera
```
::: 

::: spoiler Nemo
```
# Release planning notes
## Release notes
- First version of PCB
- quick and ugly pcb enclosure
- PCB features:
    - 13 PWM LED control
    - Temp and humidity sensor
    - accelerometer
    - ESP32-S3 mini microprocessor
    - usb type-c connector
    - stemma QT connector

## License(s) for different modules of the project
 - GPL 3.0

## Bill of materials
    - JLCPCB BOM
    - LED filament price and link

## Assembly instructions
    - minimal for this release    

## Source files
    - PCB enclosure printable files
    - sclupture printable files
    - PCB source & gerber files

## Resources and materials needed to re-use and or work in the project
    - pdf/svg of PCB eeschematic

## Acknowledgements
    - Source biological structure should be listed
    - Thank Adafruit for reference circuits (open hardware)
    - All the sources used are cited properly.
```
:::

::: spoiler Pepe
https://hackmd.io/@nyiDX_5FSJmjWwMqic4ZQQ/ByOxdZc-j
:::

::: spoiler Nanami
```
# Release planning notes
## Release notes
- Photo of the first prototype
- Description
- Status of the project
- Test results


## License(s) for different modules of the project
...

## Bill of materials
- GPS module
- IMU
- buzzer
... etc

## Assembly instructions
- Wiring diagram
- Assembly of the mounting structure

## Source files
- Code 
- Wiring diagram
- CAD of the structure
- Manual of the components? 
= Cite other project(s) if I use something

## Resources and materials needed to re-use and or work in the project

## Contributor Channels
...

## Contributor Docs
...

## User channels
...

## User Docs
- Select documentation medium
- Your documentation package in a sharable format
...

## Similar projects (Optional)


## Metadata (added if applicable)
```

:::

## Feedback
### How do you find the material
not very useful: 
long:
Very basic:
to the point: X
very advanced:

### Other remarks:

### What topics or aspects were you expecting that we missed?

