Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

TugShield: Generic software notes (Arduino API) #138

Closed
gergelytakacs opened this issue May 22, 2019 · 2 comments
Closed

TugShield: Generic software notes (Arduino API) #138

gergelytakacs opened this issue May 22, 2019 · 2 comments
Assignees
@mgulan @erik1392 @EvaVargova
Labels
arduino Issues concerning the Arduino API software Mostly software issue tug TugShield hardware and software
Projects
TugShield
Milestone
TugShield: First ...

Comments

@gergelytakacs
Copy link
Owner

gergelytakacs commented May 22, 2019 •
edited

Here are some generic notes on the API, that do not fit into any of the existing issues.

For now finish the thesis, but after that:

  • The filenames for the cpp and h should be TugShield not Tugshield. Note how you currently read a different thing in your cpp than the actual name of the header file!
  • English comments only!
  • The header comments should be expanded and arranged etc. There are misaligned lines, that have effect on your code readability.
  • There is no need to merge your branch into your own branch. Branches need to be merged (eventually) to master, but for that a correct way is to open a so-called pull request and start a short discussion if the merge should happen at all...
@gergelytakacs gergelytakacs added software Mostly software issue tug TugShield hardware and software labels May 22, 2019
@issue-label-bot
Copy link

Issue Label Bot is not confident enough to auto-label this issue. See dashboard for more details.

@gergelytakacs
Copy link
Owner Author

@EvaVargova

Next time please commit more often, so the branch is up to date. Also, please use more descriptive commits than "Latest Version" 😬

@gergelytakacs gergelytakacs added this to In progress in TugShield Oct 30, 2019
@gergelytakacs gergelytakacs changed the title TugShield: Generic software notes TugShield: Generic software notes (Arduino API) Oct 30, 2019
@gergelytakacs gergelytakacs added the arduino Issues concerning the Arduino API label Oct 30, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mgulan mgulan

@erik1392 erik1392

@EvaVargova EvaVargova

Labels
arduino Issues concerning the Arduino API software Mostly software issue tug TugShield hardware and software
Projects
TugShield
  
In progress
Milestone
TugShield: First release
Development

No branches or pull requests
4 participants
@mgulan @erik1392 @gergelytakacs @EvaVargova