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.

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

Enhancement: Clean up the code-base for DML and KINP #2

Open
15 tasks
Joshsora opened this issue Oct 31, 2018 · 0 comments
Open
15 tasks

Enhancement: Clean up the code-base for DML and KINP #2

Joshsora opened this issue Oct 31, 2018 · 0 comments
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@Joshsora
Copy link
Owner

Joshsora commented Oct 31, 2018

A list of things I want to come back to after finishing the ObjectProperty system.

  • Switch from tabs to 4 spaces.
  • Combine ki::dml::runtime_error and ki::protocol::runtime_error.
  • Create more descriptive exception types and determine when each of them is appropriate.
  • Use ki::BitStream instead of std::stream in ki::dml and ki::protocol.
  • Modularize ki::protocol::net::Session.
  • Remove the triangle inheritance in ki::protocol::net.
  • Use instance-owned receive/send buffers instead of allocating buffers for every message.
  • Choose a C++ documentation generator and document everything.
  • Write in-depth tests. Strive for 80%+ coverage.
  • Make ki::protocol::net and ki::protocol::control non-dependant on ki::dml.
  • Pass strings by constant reference.
  • Make parameters constant if possible.
  • Consider thread-safety.
  • Look into using C++ smart pointers.
  • Use C++ style casting.
@Joshsora Joshsora added the enhancement New feature or request label Oct 31, 2018
@Joshsora Joshsora self-assigned this Oct 31, 2018
@Joshsora Joshsora added this to the v1.0.0 milestone Oct 31, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant