Changes to GitHub projects guidelines

[bbratus]

Changes

• Add Repository content and layout section

  • Repository folder structure - .github, docs, files, img
  • Repository description - basic description
  • Home page content and layout - logo, title, description, specifications, image, link to files??, link to changelog??, licence, footer

• Changes to Repository naming scheme section

  • mechanics instead of mechanical

• Add Design and manufacturing files in the repositories

  • .github files
  • Files that should be uploaded to hardware and mechanics repositories
  • Naming and changes - file name should include client name, project name, part name and version

• Changes to Changelog section

  • Specify that the changelog is a separate file
  • Why does each each bullet line need to finish with a period dot?

• Changes to Versioning section

  • Hardware projects
    • a major number for major schematic and layout changes such as changes to general functionality, board shape or board dimensions,
    • a minor number for minor schematic and layout changes such as smaller changes to functionality, board shape and dimensions, components placement, layout routing and
    • a bugfix number for changes to component values, silkscreen and documentation, such that do not require new boards manufacturing
    • New projects should start with version v0.1.0 for concepts and v1.0.0 for functional devices and continue from there.
  • Mechanical projects
    • a major number for major changes such as changes to general functionality, shape and size,
    • a minor number for minor changes such as smaller changes to functionality and dimensions and
    • a bugfix number for changes to documentation, such that do not require new part manufacturing
    • New projects should start with version v0.1.0 for concepts and v1.0.0 for functional devices and continue from there.

• Changes to Documentation section

  • Remove Gitbook references

[MarkoSagadin]

Design and manufacturing files in the repositories

Specify the below as part of guidelines-docs, some information will also be contained in the default project structure.

What should be uploaded for the Mechanics into the versions control:

• STEP, STL, BOM, docs, images,

What should be part of the release for Mechanics:

• STEP, STL, BOM, zipped together as artifacts
• release notes (without image)

What should be uploaded for the Hardware into the versions control:

• the whole altium project, images of every release, docs

What should be part of the release for Hardware:

• outputs of the release generation script as artifacts, fab, pcba, src
• release notes, with image and altium365 link

Versioning

Keep all above, just further specify what is meant by the concept:

• The design is a mockup, intended only for internal use and presentation purposes.

Tasks for me

• Fix link in template:
• Say that pre-commit tool is optional the mechanics and elecotrnigs
• altium owerrides the .gitignore as it has its own.
• Add instructions for deleting the extra pre-commit files for the mechanics purpose
• Add project sturcture section in to the template
• Add automation for zipping all files under files/ dir and moving them into the assets section of the release.
• Check with Aleksej how the git and altium works and what can be done that the development process is smooth.

[MarkoSagadin]

Add instructions for setting up the repo for hardware project.

Project setup for electornics:

• there is a template project on altium, it contains .github folder, changelog, readme, checklist for project setup and automation for creating release
• new project is created on altium
• new empty repo is created on github (no template)
• electornics engineer goes thorught the checlist in the readme
• once done it uses the script to push it to the github

When creating releases:

• make changes
• document them in the changelog
• push with script
• create new release with Github automation
• generate release files locally
• upload them as assets to the github release

To make the "push to github" script a bit better:

• it should be a part of the template
• then we have no need for the manual input, project path and repo name can be automated.
• extra plus: the script is invoked from Altium.