Minisumo robot

About

This repository contains the project developed by the members of CEIMTUN-RAS at Universidad Nacional de Colombia for a minisumo robot.

Structure

The repository contains several branches each for a different purpose.

• master: Production ready code.
• develop: Workplace for developing new features.
• test:

Getting started

You can get your own copy of this project by forking it, or if you don't have a github account click this link to get a zip file of the project.

Members of the organization can clone the repository directly without forking it. Use either the GitHub Dekstop or the command line to clone the repository.

git clone https://github.com/Ceimtun-RAS/minisumo.git

Adding remote branches

Remote branches can be added to your local repo using the commandgit checkout <name-of-remote-branch>. Here are two important branches for this project.

git checkout develop 
git checkout test

Contributing

THis is a open source project and anyone is encourage to contribute. if you are interested in contributing please check the style guide.

Prerequisites

Before starting:

• Setup git and a github account.
• Have ready an Integraded Development Environment (IDE) for writing code. arduino IDE or vscode are recommended.

Contributing process

1. members of the organization can clone the repository directly. External contributors must fork the project and then clone it to their local computer.

git clone <repo-url>

2. Move to the develop branch and implement your changes.

git checkout develop 

1. Commit you changes with an informative git message. be sure to follow the guidelines and conventions.
2. push your changes and submit them for review: via pull request for external contributors and push command for members of the organization.

style guide

git message conventions

• feat (new feature for the user, not a new feature for build script)
• fix (bug fix for the user, not a fix to a build script)
• docs (changes to the documentation)
• style (formatting, missing semi colons, etc; no production code change)
• refactor (refactoring production code, eg. renaming a variable)
• test (adding missing tests, refactoring tests; no production code change)

git message conventions taken from ²

References

1. Google C++ Style Guide
2. Karma Git Commit Msg