Public:GitHub/PCB - Revision history

Lukeag3: /* Initial Setup */

2023-11-09T19:30:17Z

Initial Setup

2023-11-09T19:29:36Z

Github Checks / Actions

2023-11-09T19:29:25Z

Pull Requests

2023-11-09T19:28:27Z

Starting a Project

2023-11-09T19:27:28Z

Making Changes

2021-09-11T04:27:51Z

2021-05-11T19:43:41Z

typos and clarifications

2020-10-12T22:56:31Z

Clarify on Title Blocks

2020-10-12T22:46:23Z

Checks info

2020-10-04T18:21:00Z

Infobox Update

@@ Line 55: / Line 55: @@
 == Initial Setup ==
-In order to get the PCBs onto your computer, use <code>git clone --recursive <repo URL> <optional custom folder name></code>. The <code>--recursive</code> option looks for submodules (such as Libraries) in the repo and clones them into the correct directory. If this option was omitted during the initial clone, run the command <code>git submodule update --init</code>  to find any un-cloned submodules and clone them.
+In order to get the PCBs onto your computer, use <code>git clone <repo URL> <optional custom folder name></code>.
 Once you have the PCBs cloned onto your computer, follow the instructions to set up [[KiCad]]. Once this is done, you should be able to open the latest manufactured PCBs.
-To open a PCB that is being designed (i.e. not on master), checkout the branch using <code>git checkout <branch> --recurse-submodules</code>. If you forget the submodule option, use <code>git submodule update</code> to get the correct libraries. If you do not have the correct libraries you will only be able to see the components that were in the submodule version linked from the master branch.
+To open a PCB that is being designed (i.e. not on master), checkout the branch using <code>git checkout <branch></code>.
 ''If you cannot get components from our libraries to work for an older PCB, it may have been designed before the big libraries update that came with KiCad v5. See info on the [[KiCad]] page about upgrading projects.''

@@ Line 50: / Line 50: @@
 ==== Labeler ====
 This is an action set-up with the [https://github.com/actions/labeler Github Provided labeler] action. It just labels the PR and does not fail. Currently it isn't set up to do much, but can easily be improved by editing the [https://github.com/IlliniSolarCar/PCB/blob/master/.github/workflows/label.yml label.yml] file.
 ==== Title Block Check ====
 This check verifies the Title Blocks in your schematics and PCBs meet the requirements (it only checks the files you change on the PR). See the [[Schematic Conventions]] for Title Block information. Note that our configuration doesn't guarantee that you filled out everything correctly - but mostly just that you filled it out. You can view the regex it checks for in the [https://github.com/IlliniSolarCar/PCB/blob/master/.github/workflows/check-title-blocks.yml config file]
 == Initial Setup ==

@@ Line 37: / Line 37: @@
 === Pull Requests ===
-When you have your board ready for review you will open a Pull Request (PR) to the master branch. If applicable, the Libraries branch should also have a PR open by this point - that must be merged first. (''Note: your PCB branch must reference the master Libraries submodule before merging'').
+When you have your board ready for review you will open a Pull Request (PR) to the master branch. If applicable, the Libraries branch should also have a PR open by this point.
 Once your PR is open your board needs to be reviewed. {{Highlight|Expect your board to go through many rounds of review}} and be ready to make the needed changes. Especially on the PCB layout the changes you make can introduce new problems. It is not uncommon for the review process to result in a lot of work to do in a short time, if you don't give yourself adequate time before the board run.

@@ Line 13: / Line 13: @@
 === Starting a Project ===
-# Create and checkout a branch for your project in the PCB (and Libraries if needed) repository using <code>git checkout -b <branch></code>. Make sure you are on the latest version of the master branch while you do this!
+# Create and checkout a branch for your project in the PCB repository using <code>git checkout -b <branch></code>. Make sure you are on the latest version of the master branch while you do this!
-# Copy the latest template from the <code>Dev</code> folder
+# Copy the latest template from the <code>~/your path/PCB/Dev/Template_v0.0</code> folder
 # Rename your file structure to follow the [[Standards|Storage Conventions]] - you will have to rename the folder and each project file manually.  ''Do not'' rename the <code>.kicad_wks</code> file or you'll be sorry the nice logo and other settings disappear
 # Make an initial commit to the Libraries and PCB repositories (in that order) as below

@@ Line 27: / Line 27: @@
 # Commit the changes using <code>git commit -m "<commit message>"</code>Include a useful message to help people reading through the history see what was done.
 # Push the changes to GitHub using <code>git push</code>.
-Editing libraries requires a different process, but it's the same whether editing just the Libraries or the Libraries and the PCB files.
+Editing libraries requires a different process.
-# Edit the libraries and PCB files
+# Edit the libraries
-# Ensure your working directory is the <code>Libraries</code> directory. This is to ensure changes are being made to the library repository, instead of the PCB repository.
+# Ensure your working directory is the <code>~/your path/isc-hw-libs</code> directory. This is to ensure changes are being made to the [[GitHub/isc-hw-libs]], instead of the PCB repository.
 # Stage( <code>git add</code> ), commit( <code>git commit</code> ), and push( <code>git push</code> ) the Library changes as described above.
 # Commit and push as above.
 Whenever changes are made on another computer, you need to get the changes with the following process:
-# Pull the changes to the PCB files with <code>git pull --recurse-submodules</code>
+# Pull the changes to the PCB files with <code>git pull</code>
 === Pull Requests ===

@@ Line 1: / Line 1: @@
 {{Infobox GitHub Repo|org=IlliniSolarCar|repo=PCB|status=Active|forkOrg=|forkRepo=|defaultBranch=master|access=Private|license=All Rights Reserved to ISC|branching=Topic/Project Branches|maintainer=Electrical Group|checks=* Master Reviews Required
-* Auto labeling}}
+* Auto labeling|content=All Printed Circuit Boards Designed in KiCad}}
 [[KiCad]] conveniently uses human readable and therefore version-able text based file types. Therefore all of our PCBs are stored at {{GithubRepo|org=IlliniSolarCar|repo=PCB}} on [[GitHub]]. This version-ability is a major part of the KiCad design philosophy so the use of GitHub for PCBs is expected to continue for a long time.