search

Starflight-code / pioneer-robotics-2022

Pioneer Robotics 2022 Code
GNU General Public License v3.0
0 stars 1 forks source link

Github - Repo Documentation #4

Closed Starflight-code closed 1 year ago

Starflight-code commented 1 year ago

Add new documentation to Github, allowing team members to easily create issues and use accurate tags while doing so.

Starflight-code commented 1 year ago

Added issue templates, updated out GitHub description, and updated README.md. We're looking into adding wiki entries and improving our project planning templates.

Starflight-code commented 1 year ago

Added code comments are reformated in many areas. Code is more modular and documentation may not be needed since we have a small programming team. This issue will be closed, for now, create a new ticket if you require additional documentation.

Starflight-code commented 1 year ago

Reopened since there is discussion of an engineering notebook. This will be used to track progress on documenting code creation for the notebook if we decide on pursuing it.

Starflight-code commented 1 year ago

Added in code documentation, Repo Documentation will likely never be completed. It is currently out of scope for our objectives and the time commitment required outweighs any advantages I can foresee.