...
Code Block | ||||
---|---|---|---|---|
| ||||
Rev X.Y |
Where X represents each change changes that requires require a board new PCB to be fabricated again, and Y represents each change committed to your branchthat changes a component in the Bill of Materials. For example, if you created a new board then the first revision of any schematic version will be Rev 1.0. Once you receive the board and you realized that one of the parts should've been a 10k resistor instead of a 1k, you would change the schematic and the first board produced will be Rev 1.Y. The second revision of this board that has update the revision to Rev 1.1. Any changes that require a new board to be fabricated will then have be on Rev 2.Y. Please make sure to include the revision number inside your commit messages for easier tracking.
Commit Messages
Commit messages are added when you commit your files to your branch. By including useful information, it will allow us to easier keep track of revisions, and revert to any earlier revisions if necessary. Your commit messages should follow a similar format as this
Code Block | ||||
---|---|---|---|---|
| ||||
<HW-JiraTicketNumber> <ProjectName> <Rev X.Y> <Brief description- ofWhat what was changed in this commit>? Library Changes - List of schematic and library changes |
Your description should include enough information for anyone else on the team to understand what you're working on.
...