search

apcountryman / prototype-kicad-project-ci-cd

KiCad project CI/CD prototype.
Other
0 stars 1 forks source link

readme

prototype-kicad-project-ci-cd

CI Contributor Covenant

KiCad project GitHub Actions CI/CD prototype.

NOTE: The test printed circuit board contained within this repository was developed specifically to test the CI/CD pipeline, and does not have the finishing touches expected of a finished product

Obtaining the Source Code

HTTPS:

git clone --recurse-submodules https://github.com/apcountryman/prototype-kicad-project-ci-cd.git

SSH:

git clone --recurse-submodules git@github.com:apcountryman/prototype-kicad-project-ci-cd.git

Usage

This repository's Git pre-commit hook script is the simplest way to test this project during development. See the pre-commit script's help text for usage details.

./git/hooks/pre-commit --help

Additional checks, such as static analysis, are performed by this project's GitHub Actions CI workflow.

Versioning

prototype-kicad-project-ci-cd follows the Abseil Live at Head philosophy.

Workflow

prototype-kicad-project-ci-cd uses the GitHub flow workflow.

Git Hooks

To install this repository's Git hooks, execute the install script located in the git/hooks directory. See the install script's help text for usage details.

./git/hooks/install --help

Code of Conduct

prototype-kicad-project-ci-cd has adopted the Contributor Covenant 2.0 code of conduct. For more information, see the CODE_OF_CONDUCT.md file in this repository.

Contributing

If you are interested in contributing to prototype-kicad-project-ci-cd, please read the CONTRIBUTING.md file in this repository.

Authors

License

prototype-kicad-project-ci-cd is licensed under the CERN Open Hardware License Version 2 - Permissive (CERN-OHL-P v2). For more information, see the LICENSE file in this repository. Additional information can be found in the Guide to the CERN-OHL-P v2 which is available in both ODT and PDF formats.