Alternative - use subtree
For git experts
The following instructions publish company_model
in your_project_folder’s ScopeFoundryHW
├── your_project_folder
├── ScopeFoundryHW
├── company_model
├── company_model_hw.py
├── Licence
├── README.md
# optional
├── company_model_dev.py
├── company_model_test_app.py
├── ** more files/directory that make your hw component work
**
If you like to adhere to this template use ScopeFoundry.tools
Create the target repo on GitHub by prepending HW_
to the package
USER_NAME
HW_{company_model}
Initialize git repositiory localy
cd ScopeFoundryHW/{company_model}
git init --initial-branch=main
Commit your code. If it is the first commit, we can commit all at once
git add -A && git commit -m "Initial release"
Push your code to the remote repo
git remote add origin https://github.com/{USER_NAME}/HW_{company_model}.git
git push origin
This page periodically crawls GitHub for HW_* repos. Thereby, it considers users/organisations that forked the ScopeFoundry Repo. So this page will find your hw repo if
HW_
If it is not your repo or you do not have write access:
USER_NAME
Now you should have github repository url of the form: https://github.com/{USER_NAME}/HW_{company_model}.git
Here we push to the branch master
.
go the folder you of the hardware
cd to/your_project_folder/ScopeFoundryHW/{company_model}
Commit your code. To wrap all changes in one commit (not necessarily recommended)
git add -A && git commit -m "describe your contribution"
Push your code to the remote repo
git remote add origin https://github.com/{USER_NAME}/HW_{company_model}.git
git push origin
If you’d like to share your updates with the original owner then create a Pull Request on GitHub.
Assuming:
https://github.com/{USER_NAME}/{company_model}.git
master
mkdir ScopeFoundryHW/{company_model} && cd ScopeFoundryHW/{company_model} && git init --initial-branch=master && git remote add upstream https://github.com/{USER_NAME}/{company_model}.git && git pull upstream master && cd ../..
HINT: The entries of reference/hw-components all ready contain this line other update and run it from your Project folder
For git experts