- Master: Release version, release to client or market.
- develop: Internal development version, Head of Team/PM take responsible for it. The test team(when we have) should do testing/checking on this branch and create a pull request to master after confirm.
- personal: Can be the name of the developer, the developer takes responsibility for it. Commit and push to this branch every day of your work, developer should create at least one pull requrest to develop branth, I will check and approve it.
Note: Please create least one pull requrest a week, two to three pull requrest each week will be better.
- Describe what is this project/product, what is it for. Let the reader know what is this code for.
- What SDK/library was use for this project, how to set it up.
- Main version release note
Please ignore the build and export folder in your project.
- Example for ESP32
- SEGGER Embedded Studio
- Others in gitignore.io
Charles and Alain has been use Github in this way in pass few week, seem it is good for us create a good habit.
Trello for project development tracking
Trello is a good tool to track all the issue/question of project, and help you flow up them easily.
- Issue: For Tester/PM/Client to post up question/issue
- In Progress: Developer move the issue tag to here and start working on it.
- Under Review: Developer move the tag after he fix the issue, it is waiting tester/PM to review and verify it.
- Done: Tester/PM move the tag to done when he confirm it was fixed.
- Pending Question: (Optional)
- Documents Shared: (Optional)
I do not ask every project to start to use Trello from now immediately, but it is a very good tool for us to tracking the issue and discuss it.