Skip to content
Mono-repository for MATE ROV development.
Python
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Controller-pygame.py
Controller_Class.py
LICENSE.md
README.md
controller_class.py

README.md

🤖 mate-rov

Mono-repository for CURC's MATE ROV code.

Project Structure

TBD :)

How to Install Locally

  1. git clone
  2. TBD...

Running/Testing

  1. TBD...

Contributing

To contribute code to this repository, you must:

  1. Ensure your current code does not affect major changes from the most recent master branch. To do this, constantly run git pull every time you write new code locally.
  2. Submit a pull request to commit the changes to the repository. You'll require one approval from another developer before the code can be merged to the master branch.
  3. Once approved, your remote branch will be committed to master.

Naming Commits

Do

Provide short, accurate descriptions of your code changes.

For example:

  • Fixed backwards/forwards mixup bug
  • Changed tracking tolerance to 0.9

Don't

Provide long or cryptic commit messages.

For example:

  • Created a new technique that tracks the presence of baby dolphins in the pool and propels the robot to swim directly to these dolphins
  • Updated driver code

Naming Remote Branches

feat-FEATURE_NAME

Name your remote branch this if you are working on an entirely new feature for the project.

fix-FEATURE_NAME-##

Name your remote branch this if you are fixing an already-existing feature. Feel free to add or ommit numbers at the end of the name to discern your branch from others.

refactor-FEATURE_NAME

Name your remote branch this if you are refactoring something in an already-existing feature, such as changing a variable name. The above applies here.

test-FEATURE_NAME

Name your remote branch this if you are testing an already-existing feature. The above applies here too.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

You can’t perform that action at this time.